{"id":27020507,"url":"https://github.com/sirap-group/generate-swap-generator","last_synced_at":"2026-05-07T13:08:39.752Z","repository":{"id":57246208,"uuid":"117106699","full_name":"sirap-group/generate-swap-generator","owner":"sirap-group","description":"Generate Your Own ESNext+StandardJS+Mocha Ready NodeJS Generators In Seconds!","archived":false,"fork":false,"pushed_at":"2018-01-18T11:26:18.000Z","size":6563,"stargazers_count":2,"open_issues_count":7,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-18T22:51:05.935Z","etag":null,"topics":["babel","esnext","generate","generategenerator","generator","javascript","nodejs","standard","swap","swap-project"],"latest_commit_sha":null,"homepage":"https://sirap-group.github.io/generate-swap-generator","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/sirap-group.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-11T13:51:26.000Z","updated_at":"2018-01-30T09:27:12.000Z","dependencies_parsed_at":"2022-08-24T16:10:53.201Z","dependency_job_id":null,"html_url":"https://github.com/sirap-group/generate-swap-generator","commit_stats":null,"previous_names":["rbecheras/generate-swap-generator"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/sirap-group/generate-swap-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sirap-group%2Fgenerate-swap-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sirap-group%2Fgenerate-swap-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sirap-group%2Fgenerate-swap-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sirap-group%2Fgenerate-swap-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sirap-group","download_url":"https://codeload.github.com/sirap-group/generate-swap-generator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sirap-group%2Fgenerate-swap-generator/sbom","scorecard":{"id":827582,"data":{"date":"2025-08-11","repo":{"name":"github.com/sirap-group/generate-swap-generator","commit":"93056a715894ddb4cf9976b952e6d347b7c4225c"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 0/16 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 23 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"80 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-xcvv-84j5-jw9h","Warn: Project is vulnerable to: GHSA-66rh-8fw6-59q6","Warn: Project is vulnerable to: GHSA-8w4h-3cm3-2pm2","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx","Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-897m-rjf5-jp39","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-hr2v-3952-633q","Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9","Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm","Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h","Warn: Project is vulnerable to: GHSA-4vjr-hfpp-2m7w","Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3","Warn: Project is vulnerable to: MAL-2023-462","Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c","Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq","Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm","Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-4hpf-3wq7-5rpr","Warn: Project is vulnerable to: GHSA-f522-ffg8-j8r6","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm","Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574","Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-9g9w-hmvj-5h57","Warn: Project is vulnerable to: GHSA-r6rj-9ch6-g264","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-hxm2-r34f-qmc5","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-3mpr-hq3p-49h9","Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9","Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4","Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g","Warn: Project is vulnerable to: GHSA-8g77-54rh-46hx","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-g6ww-v8xp-vmwg","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-jv35-xqg7-f92r","Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp","Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr","Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6","Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj","Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3","Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7","Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-23T16:55:11.782Z","repository_id":57246208,"created_at":"2025-08-23T16:55:11.782Z","updated_at":"2025-08-23T16:55:11.782Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32738961,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-07T02:14:30.463Z","status":"ssl_error","status_checked_at":"2026-05-07T02:14:29.405Z","response_time":62,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["babel","esnext","generate","generategenerator","generator","javascript","nodejs","standard","swap","swap-project"],"created_at":"2025-04-04T18:31:42.687Z","updated_at":"2026-05-07T13:08:39.722Z","avatar_url":"https://github.com/sirap-group.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003ca href=\"https://github.com/sirap-group\"\u003e\u003cimg src=\"src/assets/img/brand.png\"/\u003e\u003c/a\u003e\n  \u003cbr\u003e\n  −− generate-swap-generator −−\n  \u003cbr\u003e\n  \u003cbr\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://travis-ci.org/sirap-group/generate-swap-generator\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Build Status\" src=\"https://travis-ci.org/sirap-group/generate-swap-generator.svg?branch=master\"/\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://www.npmjs.com/package/generate-swap-generator\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/dm/generate-swap-generator.svg\" alt=\"npm downloads\"\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://npmjs.org/package/generate-swap-generator\" target=\"_blank\"\u003e\n    \u003cimg alt=\"NPM version\" src=\"https://badge.fury.io/js/generate-swap-generator.svg\"/\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://standardjs.com\" target=\"_blank\"\u003e\n    \u003cimg alt=\"JavaScript Style Guide\" src=\"https://img.shields.io/badge/code_style-standard-brightgreen.svg\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch4 align=\"center\"\u003e\n  −− Generate your own ESNext/StandardJS/UnitTest Ready Generators −−\n  \u003cbr\u003e\n  \u003cbr\u003e\n  \u003ca href=\"https://www.npmjs.com/package/generate-swap-generator\" target=\"_blank\"\u003e\n    \u003cimg alt=\"NPM Stats\" src=\"https://nodei.co/npm/generate-swap-generator.png?downloads=true\u0026downloadRank=true\u0026stars=true\"/\u003e\n  \u003c/a\u003e\n\u003c/h4\u003e\n\n## Demo example\n\n![Usage example](src/assets/img/usage-screencast.gif)\n\nCheck out the following repository to see what a project generated with `generate-swap-generator` looks like out the box:\n\n\u003e [https://github.com/sirap-group/generate-swap-generator-example](https://github.com/sirap-group/generate-swap-generator-example)\n\n## Installation\n\n### Global install to use the generator as a standarlone CLI (recommanded)\n\n```sh\n$ yarn gobal add generate-swap-generator\n```\n\nor\n\n```sh\n$ npm install --global generate-swap-generator\n```\n\n### Local install to use as a `generate` plugin or sub-generator\n\n\u003e You should first visit the generator framework, [generate](https://github.com/generate/generate) to understand how generators, subgenerators and plugins work.\n\n```sh\n$ yarn add generate-swap-generator\n```\n\nor\n\n```sh\n$ npm install --save generate-swap-generator\n```\n\n## Usage\n\n### As a standalone generator (recommanded)\n\n```sh\n$ generate-swap-generator\n```\n\nShould scaffold the project in the destination path you choose when asked.\n\n### Generated files\n\n```\n.\n├─┬ src/\n| ├─┬ tests/\n| | ├─ generator.test.js\n| | └─ plugin.test.js\n| ├─┬ assets/\n| | ├─┬ img/\n| | | └── ...\n| | └─┬ templates/\n| |   └── example.txt\n| └─┬ lib/\n|   └─ generator.js\n├── contributing.md\n├── .editorconfig\n├── .git\n├── .gitattributes\n├── .gitignore\n├── .gitlab-ci.yml\n├── index.js\n├── generator.js\n├── LICENSE\n├── node_modules\n├── .npmrc\n├── package.json\n├── README.md\n└── .travis.yml\n```\n\n### As a generate plugin (if you know what you are doing)\n\n\u003e You should first visit the generator framework, [generate](https://github.com/generate/generate) to understand how generators, subgenerators and plugins work.\n\n```js\nimport generateSwapGenerator from 'generate-swap-generator'\nimport isValid from 'is-valid-app'\n\nexport default function (app) {\n  if (!isValid(app, 'generate-my-generator')) return\n\n  app.use(generateSwapGenerator)\n\n  // ... your generator's stuff\n}\n```\n\nThen you can use directly any `generate-swap-generator` tasks as a `generate-my-generator` task.\n\n```\n$ gen my-generator:keywords\n```\n\nShould run `generate-swap-generator:keywords` on your own generator instance.\n\n### As a generate sub-generator (if you know what you are doing)\n\n\u003e You should first visit the generator framework, [generate](https://github.com/generate/generate) to understand how generators, subgenerators and plugins work.\n\n```js\nimport generateSwapGenerator from 'generate-swap-generator'\nimport isValid from 'is-valid-app'\n\nexport default function (app) {\n  if (!isValid(app, 'generate-my-generator')) return\n\n  app.register('swap-generator', generateSwapGenerator)\n\n  // ... your generator's stuff\n}\n```\n\nThen you can acces easily any `generate-swap-generator` tasks as a `generate-my-generator` sub-generator task.\n\n```\n$ gen my-generator.swap-generator:keywords\n```\n\nShould run `generate-swap-generator:keywords` on your own generator instance.\n\n## API\n\n**@TODO: document the API here**\n\n## Contributing\n\n### Codebase\n\nThe codebase is written using the [ESNext Specification](https://github.com/hemanth/es-next) (ECMAScript Stage 0), following the [StandardJS Code Style](https://standardjs.com/)\n\n[![ECMASript](src/assets/img/esnext.png)](https://github.com/hemanth/es-next)\n[![JavaScript Style Guide](src/assets/img/standard.png)](https://github.com/standard/standard)\n[![ESLint](src/assets/img/eslint.png)](https://eslint.org)\n[![Babel JS](src/assets/img/babel.png)](https://babeljs.io)\n[![Yarn](src/assets/img/yarn.png)](https://yarnpkg.com/en/)\n\nWe use:\n\n- [Yarn](https://yarnpkg.com/fr/) to handle npm dependencies,\n- [ESNext CLI](https://github.com/esnext/esnext) to transform ESx code to ESNext,\n- [Babel CLI](https://babeljs.io/) to transpile ESNext code to node/browser compatible javascript,\n- And [Standard CLI](https://www.npmjs.com/package/standard) + [ESLint](https://eslint.org) to lint or format ESNext codebase.\n\n### Contribution guide\n\n\u003e See the [contribution guide](CONTRIBUTING.md) in a separated document.\n\n### Development\n\n#### Global dependencies\n\nGet the latest node engine (example with `nvm`):\n\n```sh\n$ nvm install lts/carbon\n```\n\nInstall yarn from npm (for development only):\n\n```sh\n$ npm install --global yarn\n```\n\nAll the rest of the development dependencies are local.\n\n#### Clone and install\n\nClone the repo and install dependencies:\n\n```sh\n$ git clone git@github.com:sirap-group/generate-swap-generator.git\n$ cd generate-swap-generator\n$ yarn install\n```\n#### Running test\n\nFinally, run the test pipeline:\n\n```sh\n$ yarn pipeline:test\n```\n\n#### Available yarn scripts\n\n| Task Command | Task description |\n|---|---|\n| `yarn clear` | Delete the `./build/` and `./dist` repositories |\n| `yarn lint` | Lint source files |\n| `yarn lint:esnext` | Lint ESNext source files |\n| `yarn build` | Build the whole distribution |\n| `yarn build:assets` | Build all the assets |\n| `yarn build:assets:img` | Build the images assets |\n| `yarn build:assets:templates` | Build the generator's templates |\n| `yarn build:lib` | Build only the lib |\n| `yarn build:tests` | Build only the tests |\n| `yarn build:docs` | **[TODO]** Build only the docs |\n| `yarn test` | Run the tests in `./dist/tests/` |\n| `yarn tests` | An alias for `yarn test` |\n| `yarn travis` | Run the travis script |\n| `yarn docs` | **[TODO]** Serve the docs |\n| `yarn pipeline` | Run the complete pipeline |\n| `yarn pipeline:test` | Run the required jobs to run the tests, then run the tests |\n| `yarn pipeline:build` | Run the required jobs to build the dist, then build the dist |\n| `yarn pipeline:docs` | **[TODO]** Run the required jobs to serve the docs, then serve the docs |\n| `yarn pipeline:build:tests` | Run the required jobs to build the tests, then build the tests |\n| `yarn pipeline:build:lib` | Run the required jobs to build the lib, then build the lib |\n| `yarn pipeline:build:docs` | **[TODO]** Run the required jobs to build the docs, then build the docs |\n| `yarn release` | An alias to `yarn release:patch` |\n| `yarn release:prerelease` | Release and publish a new semver version (x.y.z-rc+1)|\n| `yarn release:patch` | Release and publish a new patch semver version (`x.y.z+1`)|\n| `yarn release:minor` | Release and publish a new minor semver version (`x.y+1.z=0`)|\n| `yarn release:major` | Release and publish a new major semver version (`x+1.y=0.z=0`)|\n\n#### Develop in BDD mode\n\n\u003e **B.D.D.** means **Behavior-Driven-Development**\n\nThe project is ready to code in BDD mode. Just run the `bdd` yarn command:\n\n```\n$ yarn bdd\n```\n\nThe project will be lint, built, the BDD unit tests will be run, and the process will watch for any file changes to loop over the previous tasks (`lint`, `build`, `test`, `watch`).\n\n#### Releasing a new version\n\nThe task `yarn pipeline:build` generate a `./dist` folder in the repository's root directory but this folder is not part of the git repository (there is an entry in the `.gitignore` file). However the dist folder is included in the `package.json#files` field.\n\nThus to release a new, lets say, \"patch\" version, just run:\n\n```sh\n$ yarn release:patch\n```\n\nThe whole build pipeline is run locally (lint, transpile, test) and then a new git tag and a new npm tag are pushed up.\n\n## Related projects\n\n### SWAP Generators\n\n* [generate-swap-generator-example](https://npmjs.com/generate-swap-generator-example) An example repository to illustrate to result of generating a custom generator with generate-swap-generator [github](https://github.com/sirap-group/generate-swap-generator-example) | [homepage](https://sirap-group.github.io/generate-swap-generator-example/)\n* [generate-swap-project](https://npmjs.com/generate-swap-project) Generate An ES.Next/StandardJS/UnitTest Ready, Github or Gitlab Project in Seconds! − A generator for SWAP projects [github](https://github.com/sirap-group/generate-swap-project) | [homepage](https://sirap-group.github.io/generate-swap-project/)\n\n### Generator library stack\n\n* [generate](https://npmjs.com/generate) A new command line tool and developer framework for scaffolding out GitHub projects. Generate offers the robustness and configurability of Yeoman, the expressiveness and simplicity of Slush, and more powerful flow control and composability than either [github](https://github.com/generate/generate) | [homepage](https://generate.github.io/generate/)\n* [base](https://www.npmjs.com/package/base): Framework for rapidly creating high quality node.js applications, using plugins like building blocks | [homepage](https://github.com/node-base/base \"Framework for rapidly creating high quality node.js applications, using plugins like building blocks\")\n* [update](https://www.npmjs.com/package/update): Be scalable! Update is a new, open source developer framework and CLI for automating updates… [more](https://github.com/update/update) | [homepage](https://github.com/update/update \"Be scalable! Update is a new, open source developer framework and CLI for automating updates of any kind in code projects.\")\n* [verb](https://www.npmjs.com/package/verb): Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… [more](https://github.com/verbose/verb) | [homepage](https://github.com/verbose/verb \"Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.\")\n* [composer](https://www.npmjs.com/package/composer): API-first task runner with three methods: task, run and watch. | [homepage](https://github.com/jonschlinkert/composer)\n* [engine](https://www.npmjs.com/package/engine): Template engine based on Lo-Dash template, but adds features like the ability to register helpers… [more](https://www.npmjs.com/package/engine) | [homepage](https://github.com/jonschlinkert/engine)\n* [template](https://www.npmjs.com/package/template): Render templates using any engine. Supports, layouts, pages, partials and custom template types. Use template… [more](https://www.npmjs.com/package/template) | [homepage](https://github.com/jonschlinkert/template)\n\n## Author\n\n**Rémi Becheras**\n\n* [github.com/rbecheras](https://github.com/rbecheras)\n* [twitter/rbecheras](https://twitter.com/rbecheras)\n\n## License\n\nCopyright © 2018 [Groupe SIRAP](https://github.com/sirap-group)\n\nThis software is open source software under  the terms of the MIT license.\n\nSee [LICENSE](LICENSE)\n---\n\n\u003cp\u003e\n\u003ca href=\"https://github.com/sirap-group\" target=\"_blank\"\u003e\n  \u003cimg title=\"Groupe SIRAP\" alt=\"Groupe SIRAP\" src=\"src/assets/img/sirap.png\" width=\"200px\"\u003e\n\u003c/a\u003e This project was generated by\n\u003ca href=\"https://github.com/sirap-group/generate-swap-project\" target=\"_blank\"\u003e\ngenerate-swap-project\u003c/a\u003e, a project by \u003ca href=\"https://github.com/sirap-group\" target=\"_blank\"\u003e\nSIRAP Group\n\u003c/a\u003e\n\u003c/p\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsirap-group%2Fgenerate-swap-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsirap-group%2Fgenerate-swap-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsirap-group%2Fgenerate-swap-generator/lists"}