@zokugun/artifact

artifact is a command-line interface which allows you:

• to boilerplate your project from multiple packages
• to merge the duplicated configuration files found across the packages
• to keep your configurations up to date

Mergeable Files

• *.json (JSON or JSONC)
• *.yml
• *.yaml
• *ignore
• *rc (YAML, JSON or JSONC)

Getting Started

With node previously installed:

npm install -g @zokugun/artifact

Add the configuration packages:

artifact add @daiyam/base @daiyam/lang-ts @daiyam/npm-ts

With the previous command, artifact will pull the following packages:

• @daiyam/artifact-base
• @daiyam/artifact-lang-ts
• @daiyam/artifact-npm-ts

Like yeoman, a configuration package must be prefixed with artifact-.

Configuration Package

The configuration/boilerplate files must be put inside the folder configs.

For example, the package @daiyam/artifact-base:

artifact-configs/base/
  ├── configs/
  │  ├── .commitlintrc.yml
  │  ├── .editorconfig
  │  ├── .lintstagedrc
  │  ├── gitignore
  │  ├── package.json
  │  └── ...
  ├── LICENSE
  ├── package.json
  └── README.md

Update

Update your configurations with the command:

artifact update

It is recommended to review the changes and manually revert any bad changes.

Furthermore, a configuration package can control how to apply an update via the file .artifactrc.

Yeoman

artifact can be used in a yeoman generator. Ex: @daiyam/generator-new-project

Donations

Support this project by becoming a financial contributor.

	ko-fi.com/daiyam
	liberapay.com/daiyam/donate
	paypal.me/daiyam99

License

Copyright © 2021-present Baptiste Augrain

Licensed under the MIT license.