Xunnamius
The NPM-based tooling that underpin all of my projects
xscripts (@-xun/scripts)
xscripts is a highly-opinionated personal tool for building, linting, and
deploying my NPM-based projects. Similar in intent to kcd-scripts,
react-scripts, etc.
Install
You can install this package globally:
npm install --global @-xun/scriptsAnd then execute the CLI:
npx xscripts ...Alternatively, you can use npx to execute the CLI without pre-installation:
npx @-xun/scripts ...Usage
TODO
Appendix
Further documentation can be found under docs/.
Published Package Details
This is a CJS2 package with statically-analyzable exports
built by Babel for Node.js versions that are not end-of-life. For TypeScript
users, this package supports both "Node10" and "Node16" module resolution
strategies.
That means both CJS2 (via require(...)) and ESM (via import { ... } from ...
or await import(...)) source will load this package from the same entry points
when using Node. This has several benefits, the foremost being: less code
shipped/smaller package size, avoiding dual package
hazard entirely, distributables are not
packed/bundled/uglified, a drastically less complex build process, and CJS
consumers aren't shafted.
Each entry point (i.e. ENTRY) in package.json's
exports[ENTRY] object includes one or more export
conditions. These entries may or may not include: an
exports[ENTRY].types condition pointing to a type
declarations file for TypeScript and IDEs, an
exports[ENTRY].module condition pointing to
(usually ESM) source for Webpack/Rollup, an exports[ENTRY].node condition
pointing to (usually CJS2) source for Node.js require and import, an
exports[ENTRY].default condition pointing to source for browsers and other
environments, and other conditions not enumerated
here. Check the package.json file to see which export
conditions are supported.
Though package.json includes
{ "type": "commonjs" }, note that any ESM-only entry points will
be ES module (.mjs) files. Finally, package.json also
includes the sideEffects key, which is false for
optimal tree shaking where appropriate.
License
See LICENSE.
Contributing and Support
New issues and pull requests are always welcome and greatly appreciated! 🤩 Just as well, you can star 🌟 this project to let me know you found it useful! ✊🏿 Or you could buy me a beer 🥺Thank you!
See CONTRIBUTING.md and SUPPORT.md for more information.
Contributors
Thanks goes to these wonderful people (emoji key):
 Bernard 🚇 💻 📖 🚧 ⚠️ 👀 |
||||||
Add your contributions
|
||||||
This project follows the all-contributors specification. Contributions of any kind welcome!