Skip to content

Commit

Permalink
feat(learn): add Package Configuration article (#7229)
Browse files Browse the repository at this point in the history
* feat(learn): add Package Configuration article

* fixup!: add authorship

* fixup!: makeshift footnotes to md footnotes

* fixup!: add a "general notes" section

* fixup!: remove/update outdated info

* fixup!: tidy & simplify examples

* fixup!: "This is rarely a good idea"

* fixup!: add missing con for dual-package hazard

* fixup!: add note about potentially no need for package config

* fixup!: "me" → "us"

* fixup!: add `"default"` & `"node"` alternatives

* fixup!: correct footnote refs

* fixup!: list esm-only dist for consumption via `require()`

add note about require(esm)

* fixup!: "Pick your poison" → "Pick your fix"

* fixup!: remove errant "with"

* fixup!: alphabetical order unordered items

* fixup!: include `22.12.0` in support for `require(esm)`

* fixup!: add not recommended note to cjs with esm wrapper

* fixup!: add minimal vs advanced/verbose examples

* fixup!: add note to top "pick your fix" section for `require(esm)`

* fixup!: remove "footnotes" (it gets automatically added?)

* fixup!: correct sequence of `"default"` within `"exports"`

* fixup!: apply suggestions from code review

Co-authored-by: Augustin Mauroy <augustin.mauroy@outlook.fr>
Co-authored-by: Joyee Cheung <joyeec9h3@gmail.com>
Signed-off-by: Jacob Smith <3012099+JakobJingleheimer@users.noreply.github.com>

* fixup!: correct example

Co-authored-by: Joyee Cheung <joyeec9h3@gmail.com>
Signed-off-by: Jacob Smith <3012099+JakobJingleheimer@users.noreply.github.com>

* fixup!: wordsmith note about cjs exports reassignment

Co-authored-by: Joyee Cheung <joyeec9h3@gmail.com>
Signed-off-by: Jacob Smith <3012099+JakobJingleheimer@users.noreply.github.com>

* fixup!: provide explanation about CJS exports static analysis

Co-authored-by: Joyee Cheung <joyeec9h3@gmail.com>
Signed-off-by: Jacob Smith <3012099+JakobJingleheimer@users.noreply.github.com>

* fixup!: wordsmith `cjs-with-wrapper-dual-distro` explanation

Co-authored-by: Joyee Cheung <joyeec9h3@gmail.com>
Signed-off-by: Jacob Smith <3012099+JakobJingleheimer@users.noreply.github.com>

* fixup!: clarify ESM wrapper usefulness

Co-authored-by: Joyee Cheung <joyeec9h3@gmail.com>
Signed-off-by: Jacob Smith <3012099+JakobJingleheimer@users.noreply.github.com>

* fixup!: link to commonjs wiki

* fixup!: add live bindings caveat

* fixup!: document the dual-package hazard

* fixup!: explain pjson `"type"`

* fixup!: re-organise article & remove drink references

* fixup!: convert to mdx

* fixup!: remove missed drinks

* fixup!: rename to "publishing a package"

* fixup!: move "general notes" to bottom

* fixup!: wordsmith

* fixup!: move pros/cons after examples

* fixup!: explain "attach onto `exports`"

* fixup!: temp restore examples repo

---------

Signed-off-by: Jacob Smith <3012099+JakobJingleheimer@users.noreply.github.com>
Co-authored-by: Claudio W <cwunder@gnome.org>
Co-authored-by: Augustin Mauroy <augustin.mauroy@outlook.fr>
Co-authored-by: Joyee Cheung <joyeec9h3@gmail.com>
  • Loading branch information
4 people authored Dec 21, 2024
1 parent d41673c commit d687927
Show file tree
Hide file tree
Showing 3 changed files with 602 additions and 0 deletions.
4 changes: 4 additions & 0 deletions apps/site/navigation.json
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,10 @@
"modules": {
"label": "components.navigation.learn.modules.links.modules",
"items": {
"publishingAPackage": {
"link": "/learn/modules/publishing-a-package",
"label": "components.navigation.learn.modules.links.publishingAPackage"
},
"publishingNodeApiModules": {
"link": "/learn/modules/publishing-node-api-modules",
"label": "components.navigation.learn.modules.links.publishingNodeApiModules"
Expand Down
Loading

0 comments on commit d687927

Please sign in to comment.