PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

1.3.0

npm

@-xun/scripts

The scripts powering Xunnamius's NPM-based projects

xunnamius
Published1 Jun 2024
Direct dependencies119
Transitive dependenciesNot calculated

README

Current package documentation

The NPM-based tooling that underpin all of my projects

Black Lives Matter! Last commit timestamp Codecov Source license Uses Semantic Release!

NPM version Monthly Downloads


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/scripts

And 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.

Expand details

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

All Contributors

Thanks goes to these wonderful people (emoji key):

Bernard
Bernard
🚇 💻 📖 🚧 ⚠️ 👀
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 119

Native requirements
119 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
debug
Environment
{
  "local_name": "debug",
  "alias": false,
  "peer_metadata": null
}
^4.3.4runtime
pkg-up
Environment
{
  "local_name": "pkg-up",
  "alias": false,
  "peer_metadata": null
}
^5.0.0runtime
rimraf
Environment
{
  "local_name": "rimraf",
  "alias": false,
  "peer_metadata": null
}
^5.0.7runtime
core-js
Environment
{
  "local_name": "core-js",
  "alias": false,
  "peer_metadata": null
}
3.37.1runtime
@types/debug
Environment
{
  "local_name": "@types/debug",
  "alias": false,
  "peer_metadata": null
}
^4.1.12runtime
supports-color
Environment
{
  "local_name": "supports-color",
  "alias": false,
  "peer_metadata": null
}
^8.1.1runtime
@black-flag/core
Environment
{
  "local_name": "@black-flag/core",
  "alias": false,
  "peer_metadata": null
}
^1.2.5runtime
@projector-js/core
Environment
{
  "local_name": "@projector-js/core",
  "alias": false,
  "peer_metadata": null
}
^1.3.1runtime
glob
Environment
{
  "local_name": "glob",
  "alias": false,
  "peer_metadata": null
}
^10.4.1development
jest
Environment
{
  "local_name": "jest",
  "alias": false,
  "peer_metadata": null
}
^29.7.0development
execa
Environment
{
  "local_name": "execa",
  "alias": false,
  "peer_metadata": null
}
^5.1.1development
husky
Environment
{
  "local_name": "husky",
  "alias": false,
  "peer_metadata": null
}
^9.0.11development
doctoc
Environment
{
  "local_name": "doctoc",
  "alias": false,
  "peer_metadata": null
}
^2.2.1development
dotenv
Environment
{
  "local_name": "dotenv",
  "alias": false,
  "peer_metadata": null
}
^16.4.5development
eslint
Environment
{
  "local_name": "eslint",
  "alias": false,
  "peer_metadata": null
}
^8.57.0development
semver
Environment
{
  "local_name": "semver",
  "alias": false,
  "peer_metadata": null
}
^7.6.2development
typedoc
Environment
{
  "local_name": "typedoc",
  "alias": false,
  "peer_metadata": null
}
^0.25.13development
prettier
Environment
{
  "local_name": "prettier",
  "alias": false,
  "peer_metadata": null
}
^3.2.5development
type-fest
Environment
{
  "local_name": "type-fest",
  "alias": false,
  "peer_metadata": null
}
^4.18.3development
@babel/cli
Environment
{
  "local_name": "@babel/cli",
  "alias": false,
  "peer_metadata": null
}
^7.24.6development
babel-jest
Environment
{
  "local_name": "babel-jest",
  "alias": false,
  "peer_metadata": null
}
^29.7.0development
remark-cli
Environment
{
  "local_name": "remark-cli",
  "alias": false,
  "peer_metadata": null
}
^12.0.1development
remark-gfm
Environment
{
  "local_name": "remark-gfm",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development
typescript
Environment
{
  "local_name": "typescript",
  "alias": false,
  "peer_metadata": null
}
^5.4.5development
@types/glob
Environment
{
  "local_name": "@types/glob",
  "alias": false,
  "peer_metadata": null
}
^8.1.0development
@types/jest
Environment
{
  "local_name": "@types/jest",
  "alias": false,
  "peer_metadata": null
}
^29.5.12development
@types/node
Environment
{
  "local_name": "@types/node",
  "alias": false,
  "peer_metadata": null
}
^20.12.13development
jest-circus
Environment
{
  "local_name": "jest-circus",
  "alias": false,
  "peer_metadata": null
}
^29.7.0development
lint-staged
Environment
{
  "local_name": "lint-staged",
  "alias": false,
  "peer_metadata": null
}
^15.2.5development
remark-lint
Environment
{
  "local_name": "remark-lint",
  "alias": false,
  "peer_metadata": null
}
^10.0.0development
spellchecker
Environment
{
  "local_name": "spellchecker",
  "alias": false,
  "peer_metadata": null
}
^3.7.1development
@-xun/scripts
Environment
{
  "local_name": "@-xun/scripts",
  "alias": false,
  "peer_metadata": null
}
^1.2.0development
jest-extended
Environment
{
  "local_name": "jest-extended",
  "alias": false,
  "peer_metadata": null
}
^4.0.2development
remark-ignore
Environment
{
  "local_name": "remark-ignore",
  "alias": false,
  "peer_metadata": null
}
^2.0.0development
@types/ip6addr
Environment
{
  "local_name": "@types/ip6addr",
  "alias": false,
  "peer_metadata": null
}
^0.2.6development
glob-gitignore
Environment
{
  "local_name": "glob-gitignore",
  "alias": false,
  "peer_metadata": null
}
^1.0.14development
@commitlint/cli
Environment
{
  "local_name": "@commitlint/cli",
  "alias": false,
  "peer_metadata": null
}
^19.3.0development
@listr2/manager
Environment
{
  "local_name": "@listr2/manager",
  "alias": false,
  "peer_metadata": null
}
^2.0.8development
@types/jmespath
Environment
{
  "local_name": "@types/jmespath",
  "alias": false,
  "peer_metadata": null
}
^0.15.2development
text-extensions
Environment
{
  "local_name": "text-extensions",
  "alias": false,
  "peer_metadata": null
}
^3.0.0development
unique-filename
Environment
{
  "local_name": "unique-filename",
  "alias": false,
  "peer_metadata": null
}
^3.0.0development
lodash.mergewith
Environment
{
  "local_name": "lodash.mergewith",
  "alias": false,
  "peer_metadata": null
}
^4.6.2development
semantic-release
Environment
{
  "local_name": "semantic-release",
  "alias": false,
  "peer_metadata": null
}
https://xunn.at/semantic-release-atam@22.0.7development
@babel/preset-env
Environment
{
  "local_name": "@babel/preset-env",
  "alias": false,
  "peer_metadata": null
}
^7.24.6development
merge-descriptors
Environment
{
  "local_name": "merge-descriptors",
  "alias": false,
  "peer_metadata": null
}
^2.0.0development
sort-package-json
Environment
{
  "local_name": "sort-package-json",
  "alias": false,
  "peer_metadata": null
}
https://xunn.at/sort-package-json@2.3.0development
eslint-plugin-jest
Environment
{
  "local_name": "eslint-plugin-jest",
  "alias": false,
  "peer_metadata": null
}
^28.5.0development
remark-frontmatter
Environment
{
  "local_name": "remark-frontmatter",
  "alias": false,
  "peer_metadata": null
}
^5.0.0development
remark-lint-no-tabs
Environment
{
  "local_name": "remark-lint-no-tabs",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development
@babel/eslint-parser
Environment
{
  "local_name": "@babel/eslint-parser",
  "alias": false,
  "peer_metadata": null
}
^7.24.6development
all-contributors-cli
Environment
{
  "local_name": "all-contributors-cli",
  "alias": false,
  "peer_metadata": null
}
^6.26.1development
eslint-plugin-import
Environment
{
  "local_name": "eslint-plugin-import",
  "alias": false,
  "peer_metadata": null
}
^2.29.1development
@arethetypeswrong/cli
Environment
{
  "local_name": "@arethetypeswrong/cli",
  "alias": false,
  "peer_metadata": null
}
^0.15.3development
@semantic-release/git
Environment
{
  "local_name": "@semantic-release/git",
  "alias": false,
  "peer_metadata": null
}
^10.0.1development
@xunnamius/jest-types
Environment
{
  "local_name": "@xunnamius/jest-types",
  "alias": false,
  "peer_metadata": null
}
^1.1.3development
eslint-plugin-unicorn
Environment
{
  "local_name": "eslint-plugin-unicorn",
  "alias": false,
  "peer_metadata": null
}
^53.0.0development
remark-tight-comments
Environment
{
  "local_name": "remark-tight-comments",
  "alias": false,
  "peer_metadata": null
}
^2.0.0development
remark-validate-links
Environment
{
  "local_name": "remark-validate-links",
  "alias": false,
  "peer_metadata": null
}
^13.0.1development
@semantic-release/exec
Environment
{
  "local_name": "@semantic-release/exec",
  "alias": false,
  "peer_metadata": null
}
^6.0.3development
remark-reference-links
Environment
{
  "local_name": "remark-reference-links",
  "alias": false,
  "peer_metadata": null
}
^7.0.0development
tsconfig-replace-paths
Environment
{
  "local_name": "tsconfig-replace-paths",
  "alias": false,
  "peer_metadata": null
}
^0.0.14development
@types/lodash.mergewith
Environment
{
  "local_name": "@types/lodash.mergewith",
  "alias": false,
  "peer_metadata": null
}
^4.6.9development
remark-sort-definitions
Environment
{
  "local_name": "remark-sort-definitions",
  "alias": false,
  "peer_metadata": null
}
^2.0.0development
typedoc-plugin-markdown
Environment
{
  "local_name": "typedoc-plugin-markdown",
  "alias": false,
  "peer_metadata": null
}
^4.0.3development
@babel/preset-typescript
Environment
{
  "local_name": "@babel/preset-typescript",
  "alias": false,
  "peer_metadata": null
}
^7.24.6development
@types/merge-descriptors
Environment
{
  "local_name": "@types/merge-descriptors",
  "alias": false,
  "peer_metadata": null
}
^1.0.3development
remark-lint-no-empty-url
Environment
{
  "local_name": "remark-lint-no-empty-url",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development
@typescript-eslint/parser
Environment
{
  "local_name": "@typescript-eslint/parser",
  "alias": false,
  "peer_metadata": null
}
^7.11.0development
confusing-browser-globals
Environment
{
  "local_name": "confusing-browser-globals",
  "alias": false,
  "peer_metadata": null
}
^1.0.11development
remark-lint-final-newline
Environment
{
  "local_name": "remark-lint-final-newline",
  "alias": false,
  "peer_metadata": null
}
^3.0.0development
conventional-changelog-cli
Environment
{
  "local_name": "conventional-changelog-cli",
  "alias": false,
  "peer_metadata": null
}
^4.1.0development
remark-capitalize-headings
Environment
{
  "local_name": "remark-capitalize-headings",
  "alias": false,
  "peer_metadata": null
}
^2.0.1development
remark-lint-file-extension
Environment
{
  "local_name": "remark-lint-file-extension",
  "alias": false,
  "peer_metadata": null
}
^3.0.0development
remark-renumber-references
Environment
{
  "local_name": "remark-renumber-references",
  "alias": false,
  "peer_metadata": null
}
^2.0.0development
@semantic-release/changelog
Environment
{
  "local_name": "@semantic-release/changelog",
  "alias": false,
  "peer_metadata": null
}
^6.0.3development
remark-lint-definition-case
Environment
{
  "local_name": "remark-lint-definition-case",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development
remark-lint-list-item-style
Environment
{
  "local_name": "remark-lint-list-item-style",
  "alias": false,
  "peer_metadata": null
}
^2.0.0development
remark-lint-no-literal-urls
Environment
{
  "local_name": "remark-lint-no-literal-urls",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development
babel-plugin-module-resolver
Environment
{
  "local_name": "babel-plugin-module-resolver",
  "alias": false,
  "peer_metadata": null
}
^5.0.2development
eslint-import-resolver-alias
Environment
{
  "local_name": "eslint-import-resolver-alias",
  "alias": false,
  "peer_metadata": null
}
^1.1.2development
remark-lint-fenced-code-flag
Environment
{
  "local_name": "remark-lint-fenced-code-flag",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development
remark-lint-no-shell-dollars
Environment
{
  "local_name": "remark-lint-no-shell-dollars",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development
eslint-plugin-module-resolver
Environment
{
  "local_name": "eslint-plugin-module-resolver",
  "alias": false,
  "peer_metadata": null
}
^1.5.0development
remark-lint-hard-break-spaces
Environment
{
  "local_name": "remark-lint-hard-break-spaces",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development
remark-lint-heading-increment
Environment
{
  "local_name": "remark-lint-heading-increment",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development
remark-lint-no-empty-sections
Environment
{
  "local_name": "remark-lint-no-empty-sections",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development
remark-lint-no-inline-padding
Environment
{
  "local_name": "remark-lint-no-inline-padding",
  "alias": false,
  "peer_metadata": null
}
^4.1.2development
remark-lint-heading-whitespace
Environment
{
  "local_name": "remark-lint-heading-whitespace",
  "alias": false,
  "peer_metadata": null
}
^1.0.0development
@commitlint/config-conventional
Environment
{
  "local_name": "@commitlint/config-conventional",
  "alias": false,
  "peer_metadata": null
}
^19.2.2development
remark-lint-first-heading-level
Environment
{
  "local_name": "remark-lint-first-heading-level",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development
remark-lint-heading-word-length
Environment
{
  "local_name": "remark-lint-heading-word-length",
  "alias": false,
  "peer_metadata": null
}
^2.0.0development
@typescript-eslint/eslint-plugin
Environment
{
  "local_name": "@typescript-eslint/eslint-plugin",
  "alias": false,
  "peer_metadata": null
}
^7.11.0development
remark-lint-strikethrough-marker
Environment
{
  "local_name": "remark-lint-strikethrough-marker",
  "alias": false,
  "peer_metadata": null
}
^3.0.0development
remark-remove-unused-definitions
Environment
{
  "local_name": "remark-remove-unused-definitions",
  "alias": false,
  "peer_metadata": null
}
^2.0.0development
remark-remove-url-trailing-slash
Environment
{
  "local_name": "remark-remove-url-trailing-slash",
  "alias": false,
  "peer_metadata": null
}
^2.0.0development
eslint-import-resolver-typescript
Environment
{
  "local_name": "eslint-import-resolver-typescript",
  "alias": false,
  "peer_metadata": null
}
^3.6.1development
remark-lint-fenced-code-flag-case
Environment
{
  "local_name": "remark-lint-fenced-code-flag-case",
  "alias": false,
  "peer_metadata": null
}
^2.0.0development
remark-lint-no-reference-like-url
Environment
{
  "local_name": "remark-lint-no-reference-like-url",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development
remark-lint-no-unused-definitions
Environment
{
  "local_name": "remark-lint-no-unused-definitions",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development
remark-lint-no-heading-punctuation
Environment
{
  "local_name": "remark-lint-no-heading-punctuation",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development

Showing the first 100 declarations.

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "shasum": "5660663419397db9ac5f95b6a8bf14968d6d314b",
  "tarball": "https://registry.npmjs.org/@-xun/scripts/-/scripts-1.3.0.tgz",
  "fileCount": 47,
  "integrity": "sha512-rJpHMQc/Rbzt0ay0K+ZVSqUf2RPnn8I0TNPueGsqBgY0GHajJH2AWGsR07Ij5+BE1Q6H5tuBb9jhinwDPZ2SXQ==",
  "signatures": [
    {
      "sig": "MEUCIQD5pLbD3/uuxwjRHIIgpfeTLcHdHfILo/C1XuMSdHQlpwIgPJuOVzBSuv6cKZ+ET5wesEMwgEbAzz92Y6Wer7q2RcA=",
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"
    }
  ],
  "unpackedSize": 111693
}

Repository

PENDING
xunnamius/xscripts

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 21:52 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:3426cd39abd5d327e2aed8da98254193a427e2bfe6750d86e0c281f4e1e68a2b

Other collected versions

1.33.022 Dec1.32.011 Dec1.31.28 Dec1.31.18 Dec1.31.07 Dec1.30.34 DecView all collected versions →