{"id":18981885,"url":"https://github.com/nodeshift/new-module-starter","last_synced_at":"2025-09-06T01:32:09.387Z","repository":{"id":48269528,"uuid":"362910088","full_name":"nodeshift/new-module-starter","owner":"nodeshift","description":"A summary of what to add when creating a new node module","archived":false,"fork":false,"pushed_at":"2025-07-21T09:06:28.000Z","size":384,"stargazers_count":0,"open_issues_count":17,"forks_count":2,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-07-21T11:20:44.387Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nodeshift.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-04-29T18:24:26.000Z","updated_at":"2022-11-15T17:52:54.000Z","dependencies_parsed_at":"2024-12-09T06:27:51.988Z","dependency_job_id":"d511a578-246c-44dc-96c9-62c7dc64475c","html_url":"https://github.com/nodeshift/new-module-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nodeshift/new-module-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodeshift%2Fnew-module-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodeshift%2Fnew-module-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodeshift%2Fnew-module-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodeshift%2Fnew-module-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nodeshift","download_url":"https://codeload.github.com/nodeshift/new-module-starter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodeshift%2Fnew-module-starter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273846956,"owners_count":25178629,"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","status":"online","status_checked_at":"2025-09-05T02:00:09.113Z","response_time":402,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-11-08T16:11:35.894Z","updated_at":"2025-09-06T01:32:09.119Z","avatar_url":"https://github.com/nodeshift.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# New Module Starter\n![Node.js CI](https://github.com/nodeshift/new-module-starter/workflows/Node.js%20CI/badge.svg)\n[![Coverage Status](https://coveralls.io/repos/github/nodeshift/new-module-starter/badge.svg?branch=main)](https://coveralls.io/github/nodeshift/new-module-starter?branch=main)\n\nThis repo is for reference when creating a new node module/application in the nodeshift org.\n\n## Minimum requirements\n\n### Commit Messages\n\nWe have been trying to adhere to conventional commits, https://www.conventionalcommits.org/en/v1.0.0/, which helps when creating our changelogs and releases.\n\nWe also try to stay away from merge commits to keep the git history clean.\n\nnpm \u003e= 7\n\n```\nnpm install standard-version -D\nnpm set-script release \"standard-version\"\n```\n\nnpm \u003c 7\n\n```\nnpm install standard-version -D\n```\n\nAdd to package.json\n```\n \"scripts\": {\n    \"release\": \"standard-version\",\n```\n\nWe can run this with `--dry-run` option to see the results, for example:\n\n```\n$ npm run release -- --dry-run\n\n\u003e npcheck@0.1.13 release /home/lm/code/npcheck\n\u003e standard-version \"--dry-run\"\n\n✔ bumping version in package.json from 0.1.13 to 0.1.14\n✔ bumping version in package-lock.json from 0.1.13 to 0.1.14\n✔ created CHANGELOG.md\n✔ outputting changes to CHANGELOG.md\n\n---\n### 0.1.14 (2021-07-06)\n\n\n### Features\n\n* adding initial test structure ([#4](https://github.com/nodeshift/npcheck/issues/4)) ([e6281df](https://github.com/nodeshift/npcheck/commit/e6281df6e803ced9c6d57460821af7d8a431480e))\n---\n\n✔ committing package-lock.json and package.json and CHANGELOG.md\n✔ tagging release v0.1.14\nℹ Run `git push --follow-tags origin standard-version \u0026\u0026 npm publish` to publish\n```\n\n### License\n\nApache 2\n\n### Linter\n\nWe use eslint and extend semistandard.\n\n### Git hooks\n\nnpm \u003e= 7\n\n```\nnpm install husky -D\nnpm set-script prepare \"husky install\" \u0026\u0026 npm run prepare\nnpx husky add .husky/pre-commit \"npm test\"\n```\n\nnpm \u003c 7\n\n```\nnpm install husky -D\n```\n\nAdd to package.json\n```\n \"scripts\": {\n    \"prepare\": \"husky install\",\n```\n\nRun the commands\n```\nnpm run prepare\nnpx husky add .husky/pre-commit \"npm test\"\n```\n\n### Testing\n\nTesting framework is dependant on the project. The Reference Architecture recommendations are for Mocha or Jest. The nodeshift team has been using Tape in the past.\n\n### Coverage\n\nWe have been using the nyc module for code coverage as well as coveralls.io for hosting the results.\n\n### Support\n\nIt is recommended to add a support:true property in the package.json and also include the package-support.json.\n\n### Gitignore\n\nA node related .gitignore can be created with `npx gitignore node`.\n\n### Git Actions\n\n#### CI\nThe nodeshift org is now using Github actions for its CI.  Included in this repo is a copy of what is being used in the other repos.\n\n#### Docs\nThe nodeshift org now uses Github actions to run and publish docs under the gh_pages branch on github for each release.  Included in this repo is a copy of what is being used in the other repos.\n\n#### Releases\nThe nodeshift org now uses the Release-please github action to automate the release PRs.  Included in this repo is a copy of what is being used in the other repos.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodeshift%2Fnew-module-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnodeshift%2Fnew-module-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodeshift%2Fnew-module-starter/lists"}