{"id":19320262,"url":"https://github.com/jlyonsmith/easy","last_synced_at":"2025-02-24T05:20:27.552Z","repository":{"id":26139695,"uuid":"107459086","full_name":"jlyonsmith/easy","owner":"jlyonsmith","description":"A tool to make building, testing and releasing NodeJS projects easy!","archived":false,"fork":false,"pushed_at":"2023-01-05T16:14:04.000Z","size":1667,"stargazers_count":1,"open_issues_count":7,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-23T15:08:24.049Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jlyonsmith.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-18T20:25:40.000Z","updated_at":"2021-02-18T07:10:26.000Z","dependencies_parsed_at":"2023-01-14T04:06:19.012Z","dependency_job_id":null,"html_url":"https://github.com/jlyonsmith/easy","commit_stats":null,"previous_names":["jlyonsmith/snap-tool"],"tags_count":45,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlyonsmith%2Feasy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlyonsmith%2Feasy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlyonsmith%2Feasy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlyonsmith%2Feasy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jlyonsmith","download_url":"https://codeload.github.com/jlyonsmith/easy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240421543,"owners_count":19798589,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T01:28:02.752Z","updated_at":"2025-02-24T05:20:27.536Z","avatar_url":"https://github.com/jlyonsmith.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Easy: Node Build \u0026 Release Tool\n\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n\nA tool that makes building, testing, starting, deploying and releasing multi-package NodeJS projects **easy**!\n\n`easy` is an opinionated tool for managing a NodeJS project tree. It assumes your development environment uses:\n\n- [npm](http://npmjs.org) as the [NodeJS](http://nodejs.org) package manager\n- [git](https://git-scm.com/) to manage your source code\n- If on macOS, [iTerm2](https://www.iterm2.com/) as a scriptable replacement for the macOS Terminal app\n- [stampver](https://www.npmjs.com/package/stampver) to manage your [semantic versioning](https://semver.org/)\n- An `actor` naming convention for node sub-processes.\n\nIf you don't use all of the above, then `easy` is probably not going to be that helpful too you. Told you it was opinionated!\n\n## Installation\n\nInstall the package globally or use `npx` to run the latest version:\n\n```sh\nnpm install -g @johnls/easy\neasy --help\n```\n\nor:\n\n```sh\nnpx @johnls/easy --help\n```\n\n## Build\n\nTo build all projects recursively use:\n\n```sh\neasy build\n```\n\nYou can also specify `--install` and `--clean` with this command.\n\n## Install\n\nTo install all `npm` packages recursively use:\n\n```sh\neasy install\n```\n\nIf you specify `--clean` it will perform the `clean` command before installation.\n\n## Clean\n\nTo recursively clean out all `node_modules`, `dist`, `build` and `package-lock.json` files use:\n\n```sh\neasy clean\n```\n\n## Test\n\nTo run all tests recursively use:\n\n```sh\neasy test\n```\n\nEach command will search recursively through your project tree looking for `package.json` files to process. They each ignore `node_modules` directories.\n\n## Start\n\nIt's common to have a NodeJS based product comprised of a website, a server and perhaps mobile apps. `easy` will run all the `start` scripts recursively with:\n\n```sh\neasy start\n```\n\nEasy is also intended to be used with NodeJS servers consisting of multiple _actor_ services (or node sub-processes.) These actors processes have `script` names that start with `actor:`.\n\n```sh\neasy start --actors\n```\n\nIf `easy` finds `actor:` entries, it will start each actor process using a new iTerm2 tab in the same window so that you can shut down your entire product with one click. For that `package.json` it will not run the `start` script. Very handy for local testing.\n\n## Release\n\nThe `release` command is used to create a new tested and tagged release in Git.\n\nThe tool uses `stampver` to update version information for the build. Just tell it which part of the version to update with `patch`, `minor` or `major`.\n\nIf you add the `--deploy` it will run `npm run deploy` to run the `deploy` script. This can be whatever you want. For example, publishing to `npm` it would be done with `npm publish`. For provisioning using Ansible, it might run `ansible-playbook`.\n\n## Deploy\n\nThe `deploy` command just runs `npm run deploy`. Simple.\n\n## Rollback\n\nTo quickly rollback the current `HEAD` of all branches to the tag prior to the current tag.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlyonsmith%2Feasy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjlyonsmith%2Feasy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlyonsmith%2Feasy/lists"}