@czprz/dever

Development Helper (dev-er) to speed up and keep local development environment consistent

Usage no npm install needed!

<script type="module">
  import czprzDever from 'https://cdn.skypack.dev/@czprz/dever';
</script>

README

dever

Tool to help speed up local development and keep it consistent across a team

Getting Started

git clone https://github.com/czprz/dever.git

Prerequisites

NodeJS 14.18.1 or higher

Installing

npm install dever -g

Using dever

After dever has been installed then these commands is available.

Firstly you'll run. To find all dever.json files.

dever init

Afterwards you can list all available components by running the command

dever list

If the project you're interested in starting a local environment for is available. Use any of the keywords as [keyword] in dever [keyword] env

As an example, you might want to run the environment for a project. Then the command would possibly be like this

dever ec env --start

Additional commands are available for environment setup / help therefore it's a good idea to check possible commands like this

dever ec env

or

dever ec env --help

Or you could also check the list of commands below in the Available Commands

Available commands

Command Description
dever shows help context for dever options
dever init initializes dever by finding all dever.json files on your machine
dever list Lists all found projects
dever list --not-supported Lists all found not supported projects
dever config Show content of dever_config.json
dever config --location, -l Show location of dever_config.json
dever validate Validate any dever.json which is at the same location as the console
dever validate -f, --file Validate any dever.json using a filepath
dever [keyword] install Installs all available packages for specified project keyword if available or shows help
dever [keyword] install -l, --list List all options under install section in the projects dever.json
dever [keyword] install -lgs, --list-groups List of all installation groups under install section in the projects dever.json
dever [keyword] install -lg, --list-group List of all installs underneath a specific group in the projects dever.json
dever [keyword] install -g, --group Install all items underneath a specific group in the projects dever.json
dever [keyword] install -o, --only Install only specific package
dever [keyword] install -i, --ignore Ignore confirmations
dever [keyword] install -nba, --no-before-after Disables running of before and after functionality if defined in project dever.json
dever [keyword] env shows help context for dever env options
dever [keyword] env shows help context for dever env [keyword] options
dever [keyword] env --start attempts to start all dependencies for specific project environment
dever [keyword] env --start --clean attempts to start all dependencies for specific project environment cleanly e.g. recreating docker containers
dever [keyword] env --start --ignore attempts to start all dependencies for specific project environment with any need for confirmations
dever [keyword] env --location shows location of project dever.json
dever [keyword] env -c, --config shows content of project dever.json
dever [keyword] fix Show help context for fix command
dever [keyword] fix [key] Execute project fix listed in dever.json
dever [keyword] fix -l, --list List all available project fixes listed in dever.json
dever [keyword] fix -s, --show Show in the console what the fix will execute

Running the tests

Currently no tests implemented..

Built With

  • NodeJS - Required for development
  • npmjs - Dependency management included as part of the NodeJS installation
  • WebStorm - Main editor

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting merge requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the releases on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details