\n\n \n\n# symbiote (@-xun/symbiote)\n\n\n\n> Formerly `xscripts` (`@-xun/scripts`)\n\nSymbiote is a highly-opinionated personal tool that supercharges 🕷️ all my\nNPM-based projects. It can also exist symbiotically within foreign repositories\n(e.g. when I'm contributing to open source), glomming onto clones and granting\nme some semblance of the powers I'm used to in my own projects. All without\nrequiring changes to any of the foreign repository's files.\n\nSymbiote is similar in intent to kcd-scripts, react-scripts, etc, but with many\nmore opinions.\n\n## Motivation\n\nI have three main goals with symbiote:\n\n**I.** Concentrate the configuration explosion inherent in the modern JS\necosystem into one centralized location. That's symbiote. Reuse as much\nconfiguration from symbiote as possible. Spend as little time as possible\ntweaking configuration in repositories outside of symbiote. No more ugly\npackage.json files filled with unreadable spaghetti scripts. Never have to worry\nabout cross-environment concerns—symbiote works on both Linux and Windows.\n\nMake it easy and quick integrate shiny new tooling into symbiote as the JS\necosystem changes. And when that same tooling falls out of fashion or is\nsuperseded, make it painless to augment, upgrade, or discard that same tooling,\nor replace it with an entirely different tool, across all projects using\nsymbiote.\n\nProjects that have tight integrations with tooling that ends up changing\nincompatibly or getting replaced have the option to pin the version of symbiote\nthey require while other projects can continue to evolve as symbiote and the JS\necosystem does.\n\n \n\n**II.** Minimize to near zero the context switching penalty I incur when\nshifting focus between projects. Especially open source. Keep coding fun after\ncoding for work. Prevent burnout. Never be discouraged from returning to a very\nold project. Make each dev environment some level of predictable and familiar.\n\n \n\n**III.** Standardize my opinion of an ideal toolchain, build process, and\nrelease flow. Reduce the complexity of managing CI/CD pipelines (i.e. GitHub\nActions + [xrelease][1]) across a constellation of projects, and centralize the\nremaining complexity into [xpipeline][2].\n\nMake it super simple and unintimidating for others to contribute to\nsymbiote-powered projects. Contributions can be made without the contributor\never knowing symbiote is there. \"Continuous linting\" tools like Husky, and npm\nscripts with standard names like \"test\" and \"build\", invoke symbiote when\nnecessary. Symbiote encapsulates and hides the sprawling complexity of the JS\necosystem behind a stable-but-highly-opinionated API and CLI.\n\n\n\n---\n\n\n\n\n\n\n- [Install](#install)\n- [Usage](#usage)\n- [Appendix](#appendix)\n - [Published Package Details](#published-package-details)\n - [License](#license)\n- [Contributing and Support](#contributing-and-support)\n - [Contributors](#contributors)\n\n\n\n\n\n \n\n## Install\n\n\n\nYou can install this package globally:\n\n```shell\nnpm install --global @-xun/symbiote\n```\n\nAnd then execute the CLI:\n\n```shell\nnpx symbiote ...\n```\n\nAlternatively, you can use npx to execute the CLI without pre-installation:\n\n```shell\nnpx @-xun/symbiote ...\n```\n\n## Usage\n\n\n\nTODO\n\n\n\n## Appendix\n\n\n\nFurther documentation can be found under [`docs/`][x-repo-docs].\n\n\n\n### Published Package Details\n\nThis is a [CJS2 package][x-pkg-cjs-mojito] with statically-analyzable exports\nbuilt by Babel for use in Node.js versions that are not end-of-life. For\nTypeScript users, this package supports both `\"Node10\"` and `\"Node16\"` module\nresolution strategies.\n\n\n\n\nExpand details\n\nThat means both CJS2 (via `require(...)`) and ESM (via `import { ... } from ...`\nor `await import(...)`) source will load this package from the same entry points\nwhen using Node. This has several benefits, the foremost being: less code\nshipped/smaller package size, avoiding [dual package\nhazard][x-pkg-dual-package-hazard] entirely, distributables are not\npacked/bundled/uglified, a drastically less complex build process, and CJS\nconsumers aren't shafted.\n\nEach entry point (i.e. `ENTRY`) in [`package.json`'s\n`exports[ENTRY]`][x-repo-package-json] object includes one or more [export\nconditions][x-pkg-exports-conditions]. These entries may or may not include: an\n[`exports[ENTRY].types`][x-pkg-exports-types-key] condition pointing to a type\ndeclaration file for TypeScript and IDEs, a\n[`exports[ENTRY].module`][x-pkg-exports-module-key] condition pointing to\n(usually ESM) source for Webpack/Rollup, a `exports[ENTRY].node` and/or\n`exports[ENTRY].default` condition pointing to (usually CJS2) source for Node.js\n`require`/`import` and for browsers and other environments, and [other\nconditions][x-pkg-exports-conditions] not enumerated here. Check the\n[package.json][x-repo-package-json] file to see which export conditions are\nsupported.\n\nNote that, regardless of the [`{ \"type\": \"...\" }`][x-pkg-type] specified in\n[`package.json`][x-repo-package-json], any JavaScript files written in ESM\nsyntax (including distributables) will always have the `.mjs` extension. Note\nalso that [`package.json`][x-repo-package-json] may include the\n[`sideEffects`][x-pkg-side-effects-key] key, which is almost always `false` for\noptimal [tree shaking][x-pkg-tree-shaking] where appropriate.\n\n\n\n\n\n\n### License\n\n\n\nSee [LICENSE][x-repo-license].\n\n\n\n## Contributing and Support\n\n**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare]\nare always welcome and greatly appreciated! 🤩** Just as well, you can [star 🌟\nthis project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Or [buy\nme a beer][x-repo-sponsor], I'd appreciate it. Thank you!\n\nSee [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for\nmore information.\n\n\n\n\n### Contributors\n\n\n\n\n\n\n[](#contributors-)\n\n\n\n\nThanks goes to these wonderful people ([emoji\nkey][x-repo-all-contributors-emojis]):\n\n\n\n\n\n\n
![](\"https://raw.githubusercontent.com/Xunnamius/symbiote/refs/heads/main/logo.png\"){kind=logo}
\n![\"Bernard\"/](\"https://avatars.githubusercontent.com/u/656017?v=4?s=100\")
![](\"https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg\"){kind=logo}
\n Add your contributions\n \n