Commit Graph

55 Commits

Author SHA1 Message Date
DavHau
a015a05db4 chore: update documentation for indexers 2022-08-31 20:59:19 +02:00
DavHau
c8e889250b
Merge pull request #271 from tinybeachthor/docs-fetchers
docs: add `Fetchers` section to docs
2022-08-31 12:52:49 +02:00
Martin Toman
f2622d1e09 docs: add outline to python quickstart 2022-08-26 16:29:15 -07:00
Martin Toman
d3524727b2 docs: split out define target platforms subsection 2022-08-26 16:29:12 -07:00
Martin Toman
f41f301e58 docs: fix nodejs quickstart FAQ 2022-08-26 12:03:55 -07:00
Martin Toman
400c2406db docs: fetchers 2022-08-26 12:01:19 -07:00
Martin Toman
ed7edff5ca docs: add php subsystems section 2022-08-25 17:21:08 -07:00
Martin Toman
5893814164 docs: add nodejs to subsystems 2022-08-17 13:25:39 -07:00
DavHau
e654ffaa10 feat: module system improvements
- add documentation to the subsystem-loading interface
- expose evaled modules publicly via `framework`
- add option config.modules to allow users to include their own modules
- update examples for extending dream2nix
2022-08-15 15:34:24 +02:00
DavHau
73d0dbc482
Merge pull request #239 from tinybeachthor/docs-highlight-nix
docs: add nix syntax highlighting
2022-08-11 16:39:45 +02:00
Martin Toman
71e4ba973a docs: add nix syntax highlighting 2022-08-10 10:07:30 -07:00
Martin Toman
206bd6fe82 docs: fix typos 2022-08-09 10:35:28 -07:00
Martin Toman
3e5c108e2c docs: nodejs: add guides/getting-started-nodejs 2022-08-09 10:34:36 -07:00
Martin Toman
92d025e1ae docs: split out "Install nix" section 2022-08-06 10:02:07 -07:00
DavHau
b478f29d7a add documentation for the haskell subsystem 2022-07-22 17:19:54 +02:00
DavHau
e8fe3f803f rename examples under ./examples
Apply naming scheme {subsystem}_{test-name}
2022-07-22 16:02:21 +02:00
DavHau
9ce7b78c1f
Revert "refactor: readme/docs" 2022-07-18 18:58:36 +02:00
DavHau
3808b309dc refactor: readme/docs
The motivation of this change is to trim down the github front page (README.md). Code examples should not be part of that page. It should be short and only contain the most important information that's necessary for a rough overview.

- add sections `Quick Start` and `Presentation ...` to docs
- move usage examples from readme to `Quick Start` in the docs
- trim down the explanation about `Documentation` a bit
- move the youtube presentation to the end
-
2022-07-17 21:17:41 +02:00
DavHau
932ccb13dc fix systemsFromFile
- make use of config.projectRoot to ge relative path of systems file
2022-07-16 18:58:04 +02:00
DavHau
7cd64d386d python improvements, docs and guide.
- add warning to readme and docs stating that dream2nix is unstable software
- refactor structure of docs: remove title .md pages, instead add titles via (# title) to SUMMARY
- change order of doc topics. move `guides` and `subsystems` to the front
- add docs for python subsystem
- add getting started guide for python
- extend ./examples/python to make use of translator options
- add new function to dlib `systemsFromFile` that allows to load the `supportedSystems` from a file. This alows changing the supported systems without touching the flake.
- move pip translator args to extra file `args.nix` to allow embedding in docs
- fix pip translator
- add a .gitignore to the basic flake template
- use new systemsFromFile function in basic flake template
2022-07-16 15:03:37 +02:00
Lele Gaifax
c69534abef Fix typos in documentation 2022-07-14 11:31:44 +02:00
Yusuf Bera Ertan
d657fcfac8
docs: fix development roundup section 2022-07-12 16:42:12 +03:00
Yusuf Bera Ertan
05167f7e6f
feat: indexers (#184)
* feat: add translate and shell commands

* feat: add indexer modules

* feat(nodejs): add a basic npm indexer

* feat: add an index app for indexing using an indexer

* feat(rust): add crates-io indexer

* refactor: use configFile in more places

* feat: implement translate-index app

* refactor: move indexers out of subsystems since they aren't subsystem specific

* fix: discard string context for config text

* docs: add a preliminary document for indexers

* docs: add examples for crates-io and npm indexer inputs

* feat: add support for setting sourceRoot in dream-lock, fix translate source patching

* fix: don't discard context from config passed as text

* fix: remove duplicate resolves

* fix: shell command

* refactor: remove useless nix calls, improve the apps

* feat: improve cli apps UX, implement runNixCmdInSrc, remove shell

* docs: more comments

* feat: add generatePackagesFromLocksTree util

* fix: pass args to generatePackagesFromDreamLocks correctly

* Update indexers.md

* chore: remove license from crates-io indexer

* fix: pass config loaded from env vars to loadConfig

* refactor: don't expose dream2nix internally

* feat: add makeOutputsForIndexes utility

* refactor: make make(Flake)OutputsForIndexes interface consistent with make(Flake)Outputs

* fix: allow passing pkgs to makeFlakeOutputsForIndexes

* fix: remove unused code

* fix: rename var to expected name

* refactor(utils/index): improve and fix overrideOutputs arg

* fix(utils/index): actually pass prev outputs to overrideOutputs

* refactor: patch all sources instead of using a seperate field in dream lock

* fix(utils/index): use .program to access the program

* fix: correct jq command in translate app

* refactor: improve translate app performance

* feat: add crates-io-simple indexer

* fix(apps/translate): only set dir if relPath is set

* fix(apps/callNixWithD2N): pin nixpkgs

* fix: unloaded config passed to dlib

* refactor: rewrite root source patching in nix

* tests: add a unit test for replace root sources

Co-authored-by: DavHau <hsngrmpf+github@gmail.com>
2022-07-12 12:33:04 +02:00
DavHau
6eb67f2775
Merge pull request #188 from nix-community/dev-roundups
Add development roundup April - June
2022-07-12 11:07:34 +02:00
Yusuf Bera Ertan
757501574f
docs: add more examples for overriding rust-toolchain 2022-07-06 20:30:29 +03:00
Yusuf Bera Ertan
cb09518ff9
docs: mention more stuff in dev roundup 2022-07-06 19:10:51 +03:00
Yusuf Bera Ertan
5e0de19443
docs: move development round ups to separate files 2022-07-06 19:03:04 +03:00
DavHau
4e5e4e4a14 Add development roundup April - June 2022-07-06 16:00:02 +02:00
DavHau
89bfa7c971 docs: rename Concepts and Benefits -> Architectural Considerations 2022-07-06 15:43:21 +02:00
Yusuf Bera Ertan
1ba9555ecf
docs: add the haskell subsystem to subsystems doc 2022-06-21 19:16:05 +03:00
Yusuf Bera Ertan
2dcf2ab21e
docs: fix formatting in rest of the documentation 2022-06-21 19:15:29 +03:00
Yusuf Bera Ertan
5f20f98aa2
feat: implement overrideRustToolchain for crane and build-rust-package (#175) 2022-06-18 18:24:05 +03:00
Yusuf Bera Ertan
7005441ceb
docs: setup mdbook book for documentation, add CLI app for docs (#173)
* docs: setup mdbook book for documentation

* ci: add github action for docs

* docs: add a cli command for showing docs in terminal

* Update docs/src/subsystems/rust.md

Co-authored-by: Ilan Joselevich <personal@ilanjoselevich.com>

* docs(rust): add example for crane overriding

* docs: add a further reading section to intro

* docs: fix a few links

* docs(readme): move documentation section up and fit some sections into 80 columns

Co-authored-by: Ilan Joselevich <personal@ilanjoselevich.com>
2022-06-13 22:27:05 +03:00
Yusuf Bera Ertan
645c6fd98e
refactor: implement a validation system for builders / translators, reorganize files (#155)
* refactor: implement a validation system for builders / translators etc, organize files

* refactor: use seq instead of complicated validation function for validator

* feat: allow adding discoverers, translators and builders via config

* refactor: rework discoverers to use makeSubsystemModules as well

* fix: validate extra modules properly

* feat: support inline modules

* feat: use extra attribute for extending

* feat: make fetchers extensible properly

* fix: add name to extra fetchers

* feat: support list for extra

* docs: add some comment to lib/modules.nix

* fix: get extra module args from extraArgs

* fix: collect all modules instead of only collecting modules for built-in subsystems

* refactor: minor improvements

* refactor: improve how default subsystem modules are declared

* fix: translators and builders are directly under subsystem now

* fix: correct attribute path, remove unused argument

* fix: correct translators attribute paths

* fix: correct file paths and translators attribute paths

* fix: use correct translator attr path in wrapPureTranslator

* fix: update unit tests code

* fix: remove extra paranthesis in unit tests code

* tests: add an extended dream2nix example

* refactor: replace recursiveUpdate usage with normal update op

* tests: fix and extend d2n-extended example

* fix: pass config to d2n instance in wrap pure translator script

* fix: correct toFile usage

* fix: pass config to dlib in more places

* fix: pass config to d2n instance in aggregated hashes cli and gomod2nix translator

* refactor: remove unused extra modules validation, add warning for function modules

* fix: remove non-existent inherited variable

* docs: update translator attr path in contributors guide

* docs: add docs for extending dream2nix

* refactor: comment more code, warn for function modules only if extra is an attrset decl

* docs: fix some typos

* docs: explain some stuff in extending d2n better

* fix: print function modules warning when it is a function

* tests: add a new example that tests adding new subsystem and config.extra as nix file

* tests: use cargo-toml as translator on d2n-extended to potentially catch more bugs

* feat: add ifd warning for builders

* tests: use build-rust-package builder instead of crane builder in d2n-extended to also test it instead of only testing crane builder

* fix(rust/builders): always write the generated Cargo.lock so it doesnt get out of sync with our dream-lock

* fix(rust/builders): delete cargo lock before writing it?

* refactor: also print ifd warnings for translators

* docs: link extending d2n doc in readme, link examples in extending d2n

* docs: example naming (translators.new -> translators.example-translator)

* feat: allow setting nix files for modules declarations (eg. subsystems, subsystems.translators)

* refactor: move IFD warnings to src/lib/builders.nix / translators.nix respectively

* refactor: throw instead of warning if function declarations for modules are used

* refactor: fix throw usage

* refactor: improve modules code

* chore(deps): update nixpkgs

* fix: correct some map usages

* fix: use correct attr path for extra modules

* chore: update examples flake inputs

* style: minor formatting changes
2022-05-29 21:42:47 +02:00
DavHau
fb3789c9a1 update contributors guide 2022-05-19 17:58:08 +02:00
DavHau
25c5d26596 fix URL to overrides in docs 2022-02-18 15:14:01 +07:00
DavHau
49416753cf
Merge pull request #79 from raboof/patch-2
typo: tanslator -> translator
2022-02-04 22:43:55 +07:00
Arnout Engelen
6427775e87
typo: tanslator -> translator 2022-02-04 16:38:14 +01:00
Arnout Engelen
dad2395b01
typo compsition -> composition 2022-02-04 16:29:21 +01:00
DavHau
baa442739f add template and docs for contributing builder 2021-11-08 11:47:15 +07:00
DavHau
46f0818559 fix typo in override-system.md 2021-11-07 15:26:06 +07:00
DavHau
d56edddc3e document override system 2021-11-07 15:18:28 +07:00
DavHau
a1d0ed99a8 restructure / rename dream-lock attributes 2021-11-04 15:36:12 +07:00
DavHau
d20f318b58 rename several things
- rename fetcher 'fetchurl' -> 'http'
  - rename specialArgs -> extraArgs
  - rename order_dict -> sort_dict
2021-10-29 21:18:58 +07:00
DavHau
055102e698 use utils.writePureShellScript for all translators 2021-10-22 14:56:56 +07:00
DavHau
89e0b3633d update docs and dream.lock example 2021-10-12 22:01:39 +07:00
DavHau
7f19e0662f finalize new CLI 2021-10-06 10:16:00 +07:00
DavHau
ca22d7b59b fix typo in readme 2021-10-06 10:16:00 +07:00
DavHau
f0ca8382a5
Rename contributers-guide.md to contributors-guide.md 2021-10-05 00:07:12 +07:00
DavHau
64c0b7036b docs: add contributors guide 2021-09-30 01:35:46 +01:00