https://github.com/wessouza/wes-cli

CLI for maintaining configuration files across different projects
https://github.com/wessouza/wes-cli

cli config nodejs typescript

Last synced: 2 months ago
JSON representation

CLI for maintaining configuration files across different projects

• Host: GitHub
• URL: https://github.com/wessouza/wes-cli
• Owner: WesSouza
• License: mit
• Created: 2021-12-30T02:46:02.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-05T14:26:44.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T06:42:25.667Z (9 months ago)
• Topics: cli, config, nodejs, typescript
• Language: TypeScript
• Homepage:
• Size: 874 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# wes-cli

[![CI Tests status badge](https://github.com/WesSouza/wes-cli/actions/workflows/lint-typecheck-test-build.yml/badge.svg)](https://github.com/WesSouza/wes-cli/actions/workflows/lint-typecheck-test-build.yml?query=branch%3Amain) [![npm version](https://badge.fury.io/js/wes-cli.svg)](https://www.npmjs.com/package/wes-cli)

Collection of CLI commands that make my life easier, such as maintaining

configuration files across different projects. It might help you too!

## Commands

### `wes install`

Reads `wes-config.json` file in the current directory and installs files related

to all dependencies. All files are added to the `.gitignore` file because they

are generated and copied from the package itself.

All configurations are merged with each other, allowing multiple packages to

change the same configuration depending on their need. The current logic is

extremely simplistic (plain text files are appended, JSON files are deeply

merged, yarn.lock files are regenerated). Files which can't be merged can be

used, but only one version should exist, as another will generate a conflict.

Local overrides to configured files should be added to `.wes-defaults/local`,

which will be merged last to take precedence for potential overrides.

This project is built using itself, so you can peek at

[wes-config.json](./wes-config.json) and

[.wes-defaults/local](./.wes-defaults/local) to get a sense of usage.

You can see a list of dependencies as folders on [modules](./modules).

## Configuration

### wes-config.json

Supported properties:

* All versions:

  * `version: number`: Configuration version (latest is `2`)

  * `dependencies: string[]`: List of modules to import configurations files

    from. See [modules](./modules) for all supported dependencies.

* Version > 2:

  * `localOverrides?: string[]`: List of file paths from `.wes-defaults/local`

    that should be kept as is, not merging with any module's version. Paths

    shouldn't include a leading /.

## License

MIT, https://wes.dev/LICENSE.txt