1build is an automation tool that arms you with the convenience to configure project-local command line aliases – and then run the commands quickly and easily. It is particularly helpful when you deal with multiple projects and switch between them all the time. It is often the fact that different projects use different build tools and have different environment requirements – and then switching from one project to another is becoming increasingly cumbersome. That is where 1build comes into play.
With 1build you can create simple and easily memorable command aliases for commonly used project commands such as build, test, run or anything else. These aliases will have a project-local scope which means that they will be accessible only within the project directory. This way you can unify all your projects to build with the same simple command disregarding of what build tool they use. It will remove the hassle of remembering all those commands improving the mental focus for the things that actually matter.
- Download and unzip latest release v1.2.0 for your OS.
- Move the
1build
executable to your$PATH
.
- Create
1build.yaml
configuration file by1build init --name <your_project_name>
- Edit file according to project command list, Example of
1build.yaml
for node project:project: Sample JVM Project Name commands: - build: npm run build - test: npm run test
-
building the project
1build build
-
fix the coding guidelines lint and run tests (executing more than one commands at once)
1build lint test
- Set new command configuration for
lint
to"eslint server.js"
1build set lint "eslint server.js"
- Unset command configuration for
lint
1build unset lint
Consider that your project requires some environment variables to set before running any
commands and you want to clean up those after running commands. It is a headache to always
remember to set those environment variables. What you want is to set env variables automatically
when you run the command in the project and remove those when the command is complete.
Another example – a project requires Docker
to be up
and running or you need to clean up the database after running a test harness.
This is where before
& after
commands are useful. These commands are both optional –
you can use one of them, both or neither.
-
Setting env variables and cleaning those up
project: Sample JVM Project Name before: export VARNAME="my value" after: unset VARNAME commands: - build: npm run build
-
Ensure that
Docker
is up and runningproject: Containerized Project before: ./docker_run.sh commands: - build: npm run build
-
Clean up database after some commands
project: Containerized Project after: ./clean_database.sh commands: - build: npm run build
See 1build --help
for command usages.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use Semantic Versioning for all our releases. For the versions available, see the tags on this repository.
All notable changes to this project in each release will be documented in CHANGELOG.md.
The format is based on Keep a Changelog.
This project is licensed under the MIT License - see the LICENSE file for details
- Gopinath Langote - Initial work & Maintainer – Github –Twitter
- Alexander Lukianchuk - Maintainer – Github – Twitter
See also the list of contributors who participated in this project.
![1build](https://github.com/gopinath-langote/1build/raw/master/docs/assets/jetbrains.png?raw=true)
![1build](https://github.com/gopinath-langote/1build/raw/master/docs/assets/1password.png?raw=true)