[ { "path": ".all-contributorsrc", "content": "{\n \"projectName\": \"generator-kcd-oss\",\n \"projectOwner\": \"kentcdodds\",\n \"imageSize\": 100,\n \"commit\": false,\n \"contributorsPerLine\": 7,\n \"repoHost\": \"https://github.com\",\n \"repoType\": \"github\",\n \"skipCi\": false,\n \"files\": [\n \"README.md\"\n ],\n \"contributors\": [\n {\n \"login\": \"kentcdodds\",\n \"name\": \"Kent C. Dodds\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/1500684?v=3\",\n \"profile\": \"https://kentcdodds.com\",\n \"contributions\": [\n \"code\",\n \"doc\",\n \"infra\"\n ]\n },\n {\n \"login\": \"reznord\",\n \"name\": \"Anup\",\n \"avatar_url\": \"https://avatars0.githubusercontent.com/u/3415488?v=4\",\n \"profile\": \"https://github.com/reznord\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"edm00se\",\n \"name\": \"Eric McCormick\",\n \"avatar_url\": \"https://avatars3.githubusercontent.com/u/622118?v=4\",\n \"profile\": \"https://edm00se.codes/\",\n \"contributions\": [\n \"doc\"\n ]\n },\n {\n \"login\": \"MichaelDeBoey\",\n \"name\": \"MichaΓ«l De Boey\",\n \"avatar_url\": \"https://avatars3.githubusercontent.com/u/6643991?v=4\",\n \"profile\": \"https://michaeldeboey.be\",\n \"contributions\": [\n \"code\",\n \"doc\"\n ]\n },\n {\n \"login\": \"MatanBobi\",\n \"name\": \"Matan Borenkraout\",\n \"avatar_url\": \"https://avatars2.githubusercontent.com/u/12711091?v=4\",\n \"profile\": \"https://matan.io\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"nickmccurdy\",\n \"name\": \"Nick McCurdy\",\n \"avatar_url\": \"https://avatars0.githubusercontent.com/u/927220?v=4\",\n \"profile\": \"https://nickmccurdy.com/\",\n \"contributions\": [\n \"doc\",\n \"code\"\n ]\n }\n ]\n}\n" }, { "path": ".gitattributes", "content": "* text=auto eol=lf\n" }, { "path": ".github/workflows/validate.yml", "content": "name: validate\non:\n push:\n branches:\n - '+([0-9])?(.{+([0-9]),x}).x'\n - 'main'\n - 'next'\n - 'next-major'\n - 'beta'\n - 'alpha'\n - '!all-contributors/**'\n pull_request: {}\njobs:\n main:\n # ignore all-contributors PRs\n if: ${{ !contains(github.head_ref, 'all-contributors') }}\n strategy:\n matrix:\n node: [12, 14, 16]\n runs-on: ubuntu-latest\n steps:\n - name: πŸ›‘ Cancel Previous Runs\n uses: styfle/cancel-workflow-action@0.9.0\n\n - name: ⬇️ Checkout repo\n uses: actions/checkout@v2\n\n - name: βŽ” Setup node\n uses: actions/setup-node@v2\n with:\n node-version: ${{ matrix.node }}\n\n - name: πŸ“₯ Download deps\n uses: bahmutov/npm-install@v1\n with:\n useLockFile: false\n env:\n HUSKY_SKIP_INSTALL: true\n\n - name: ▢️ Run validate script\n run: npm run validate\n\n - name: ⬆️ Upload coverage report\n uses: codecov/codecov-action@v2\n\n release:\n needs: main\n runs-on: ubuntu-latest\n if:\n ${{ github.repository == 'kentcdodds/generator-kcd-oss' &&\n contains('refs/heads/main,refs/heads/beta,refs/heads/next,refs/heads/alpha',\n github.ref) && github.event_name == 'push' }}\n steps:\n - name: πŸ›‘ Cancel Previous Runs\n uses: styfle/cancel-workflow-action@0.9.0\n\n - name: ⬇️ Checkout repo\n uses: actions/checkout@v2\n\n - name: βŽ” Setup node\n uses: actions/setup-node@v2\n with:\n node-version: 14\n\n - name: πŸ“₯ Download deps\n uses: bahmutov/npm-install@v1\n with:\n useLockFile: false\n env:\n HUSKY_SKIP_INSTALL: true\n\n - name: πŸš€ Release\n uses: cycjimmy/semantic-release-action@v2\n with:\n semantic_version: 17\n branches: |\n [\n '+([0-9])?(.{+([0-9]),x}).x',\n 'main',\n 'next',\n 'next-major',\n {name: 'beta', prerelease: true},\n {name: 'alpha', prerelease: true}\n ]\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n" }, { "path": ".gitignore", "content": "node_modules\ncoverage\ndist\n.DS_Store\n\n# these cause more harm than good\n# when working with contributors\npackage-lock.json\nyarn.lock\n" }, { "path": ".huskyrc.js", "content": "module.exports = require('kcd-scripts/husky')\n" }, { "path": ".npmrc", "content": "package-lock=false\n" }, { "path": ".prettierignore", "content": "node_modules\ncoverage\ndist\n\n_package.json\n" }, { "path": ".prettierrc.js", "content": "module.exports = require('kcd-scripts/prettier')\n" }, { "path": "CHANGELOG.md", "content": "# CHANGELOG\n\nThe changelog is automatically updated using\n[semantic-release](https://github.com/semantic-release/semantic-release). You\ncan see it on the [releases page](../../releases).\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, religion, or sexual identity and\norientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.\n\n## Our Standards\n\nExamples of behavior that contributes to a positive environment for our\ncommunity include:\n\n- Demonstrating empathy and kindness toward other people\n- Being respectful of differing opinions, viewpoints, and experiences\n- Giving and gracefully accepting constructive feedback\n- Accepting responsibility and apologizing to those affected by our mistakes,\n and learning from the experience\n- Focusing on what is best not just for us as individuals, but for the overall\n community\n\nExamples of unacceptable behavior include:\n\n- The use of sexualized language or imagery, and sexual attention or advances of\n any kind\n- Trolling, insulting or derogatory comments, and personal or political attacks\n- Public or private harassment\n- Publishing others' private information, such as a physical or email address,\n without their explicit permission\n- Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Enforcement Responsibilities\n\nCommunity leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.\n\n## Scope\n\nThis Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at\nme+coc@kentcdodds.com. All complaints will be reviewed and investigated promptly\nand fairly.\n\nAll community leaders are obligated to respect the privacy and security of the\nreporter of any incident.\n\n## Enforcement Guidelines\n\nCommunity leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:\n\n### 1. Correction\n\n**Community Impact**: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.\n\n### 2. Warning\n\n**Community Impact**: A violation through a single incident or series of\nactions.\n\n**Consequence**: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or permanent\nban.\n\n### 3. Temporary Ban\n\n**Community Impact**: A serious violation of community standards, including\nsustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.\n\n### 4. Permanent Ban\n\n**Community Impact**: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within the\ncommunity.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage],\nversion 2.0, available at\nhttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.\n\nCommunity Impact Guidelines were inspired by\n[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see the FAQ at\nhttps://www.contributor-covenant.org/faq. Translations are available at\nhttps://www.contributor-covenant.org/translations.\n" }, { "path": "CONTRIBUTING.md", "content": "# Contributing\n\nThanks for being willing to contribute!\n\n**Working on your first Pull Request?** You can learn how from this _free_\nseries [How to Contribute to an Open Source Project on GitHub][egghead]\n\n## Project setup\n\n1. Fork and clone the repo\n2. `$ npm install` to install dependencies\n3. `$ npm run validate` to validate you've got it working\n4. Create a branch for your PR\n\n> Tip: Keep your `main` branch pointing at the original repository and make\n> pull requests from branches on your fork. To do this, run:\n>\n> ```\n> git remote add upstream https://github.com/kentcdodds/generator-kcd-oss\n> git fetch upstream\n> git branch --set-upstream-to=upstream/main main\n> ```\n>\n> This will add the original repository as a \"remote\" called \"upstream,\" Then\n> fetch the git information from that remote, then set your local `main`\n> branch to use the upstream main branch whenever you run `git pull`. Then you\n> can make all of your pull request branches based on this `main` branch.\n> Whenever you want to update your version of `main`, do a regular `git pull`.\n\n## Committing and Pushing changes\n\nPlease make sure to run the tests before you commit your changes. You can run\n`npm run test:update` which will update any snapshots that need updating. Make\nsure to include those changes (if they exist) in your commit.\n\n## Help needed\n\nPlease checkout the [the open issues][issues]\n\nAlso, please watch the repo and respond to questions/bug reports/feature\nrequests! Thanks!\n\n\n[egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github\n[all-contributors]: https://github.com/all-contributors/all-contributors\n[issues]: https://github.com/kentcdodds/generator-kcd-oss/issues\n\n" }, { "path": "LICENSE", "content": "The MIT License (MIT)\nCopyright (c) 2017 Kent C. Dodds\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "README.md", "content": "
\n

generator-kcd-oss

\n\n

An open source project generator for my open source projects :)

\n
\n\n---\n\n\n[![Build Status][build-badge]][build]\n[![version][version-badge]][package]\n[![downloads][downloads-badge]][npmtrends]\n[![MIT License][license-badge]][license]\n[![All Contributors][all-contributors-badge]](#contributors-)\n[![PRs Welcome][prs-badge]][prs]\n[![Code of Conduct][coc-badge]][coc]\n\n\n## The problem\n\nI have to do a lot of repetitive stuff every time I set up a new open source\nproject.\n\n## This solution\n\nThis is a yeoman generator for my open source projects\n\n## Table of Contents\n\n\n\n\n- [Installation](#installation)\n - [Try Without Installing](#try-without-installing)\n- [Usage](#usage)\n- [Inspiration](#inspiration)\n- [Issues](#issues)\n - [πŸ› Bugs](#-bugs)\n - [πŸ’‘ Feature Requests](#-feature-requests)\n- [Contributors ✨](#contributors-)\n- [LICENSE](#license)\n\n\n\n## Installation\n\nThis module is distributed via [npm][npm] which is bundled with [node][node] and\nshould be installed globally (with `yo`):\n\n```sh\nnpm install -g generator-kcd-oss yo\n```\n\n### Try Without Installing\n\n```sh\nnpx -p yo -p generator-kcd-oss -c 'yo kcd-oss'\n```\n\n## Usage\n\n```sh\nyo kcd-oss\n```\n\nFollow the prompts...\n\n## Inspiration\n\nI referenced [@sindresorhus][sindresorhus]'s [module][generator-nm] heavily.\n\n## Issues\n\n_Looking to contribute? Look for the [Good First Issue][good-first-issue]\nlabel._\n\n### πŸ› Bugs\n\nPlease file an issue for bugs, missing documentation, or unexpected behavior.\n\n[**See Bugs**][bugs]\n\n### πŸ’‘ Feature Requests\n\nPlease file an issue to suggest new features. Vote on feature requests by adding\na πŸ‘. This helps maintainers prioritize what to work on.\n\n[**See Feature Requests**][requests]\n\n## Contributors ✨\n\nThanks goes to these people ([emoji key][emojis]):\n\n\n\n\n\n \n \n \n \n \n \n \n \n
\"\"/
Kent C. Dodds
πŸ’» πŸ“– πŸš‡		\"\"/
Anup
πŸ“–		\"\"/
Eric McCormick
πŸ“–		\"\"/
MichaΓ«l De Boey
πŸ’» πŸ“–		\"\"/
Matan Borenkraout
πŸ’»		\"\"/
Nick McCurdy
πŸ“– πŸ’»
\n\n\n\n\n\n\nThis project follows the [all-contributors][all-contributors] specification.\nContributions of any kind welcome!\n\n## LICENSE\n\nMIT\n\n\n[npm]: https://www.npmjs.com\n[node]: https://nodejs.org\n[build-badge]: https://img.shields.io/github/workflow/status/kentcdodds/generator-kcd-oss/validate?logo=github&style=flat-square\n[build]: https://github.com/kentcdodds/generator-kcd-oss/actions?query=workflow%3Avalidate\n[version-badge]: https://img.shields.io/npm/v/generator-kcd-oss.svg?style=flat-square\n[package]: https://www.npmjs.com/package/generator-kcd-oss\n[downloads-badge]: https://img.shields.io/npm/dm/generator-kcd-oss.svg?style=flat-square\n[npmtrends]: https://www.npmtrends.com/generator-kcd-oss\n[license-badge]: https://img.shields.io/npm/l/generator-kcd-oss.svg?style=flat-square\n[license]: https://github.com/kentcdodds/generator-kcd-oss/blob/master/LICENSE\n[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\n[prs]: https://makeapullrequest.com\n[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square\n[coc]: https://github.com/kentcdodds/generator-kcd-oss/blob/master/CODE_OF_CONDUCT.md\n[emojis]: https://github.com/all-contributors/all-contributors#emoji-key\n[all-contributors]: https://github.com/all-contributors/all-contributors\n[all-contributors-badge]: https://img.shields.io/github/all-contributors/kentcdodds/generator-kcd-oss?color=orange&style=flat-square\n[bugs]: https://github.com/kentcdodds/generator-kcd-oss/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Acreated-desc+label%3Abug\n[requests]: https://github.com/kentcdodds/generator-kcd-oss/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement\n[good-first-issue]: https://github.com/kentcdodds/generator-kcd-oss/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement+label%3A%22good+first+issue%22\n\n[sindresorhus]: https://github.com/sindresorhus\n[generator-nm]: https://github.com/sindresorhus/generator-nm\n\n" }, { "path": "generators/app/index.js", "content": "const Generator = require('yeoman-generator')\nconst kebabCase = require('lodash.kebabcase')\n\nmodule.exports = class extends Generator {\n init() {\n return this.prompt([\n {\n name: 'moduleName',\n message: 'What do you want to name your module?',\n default: this.appname.replace(/\\s/g, '-'),\n filter: x => kebabCase(x).toLowerCase(),\n },\n {\n name: 'devDep',\n message: 'Should people install this as one of their devDependencies?',\n default: true,\n type: 'confirm',\n },\n {\n name: 'description',\n message: `What's the project description?`,\n type: 'input',\n },\n ]).then(props => {\n const mv = (from, to) => {\n this.fs.move(this.destinationPath(from), this.destinationPath(to))\n }\n\n this.fs.copyTpl(\n [`${this.templatePath()}/**`],\n this.destinationPath(),\n props,\n )\n\n mv('gitattributes', '.gitattributes')\n mv('gitignore', '.gitignore')\n mv('npmrc', '.npmrc')\n mv('_package.json', 'package.json')\n mv('all-contributorsrc', '.all-contributorsrc')\n mv('huskyrc.js', '.huskyrc.js')\n mv('prettierrc.js', '.prettierrc.js')\n mv('prettierignore', '.prettierignore')\n mv('github/ISSUE_TEMPLATE.md', '.github/ISSUE_TEMPLATE.md')\n mv('github/PULL_REQUEST_TEMPLATE.md', '.github/PULL_REQUEST_TEMPLATE.md')\n mv('github/workflows/validate.yml', '.github/workflows/validate.yml')\n })\n }\n install() {\n this.spawnCommand('git', ['init', '--initial-branch', 'main'])\n this.npmInstall()\n }\n}\n" }, { "path": "generators/app/templates/CHANGELOG.md", "content": "# CHANGELOG\n\nThe changelog is automatically updated using\n[semantic-release](https://github.com/semantic-release/semantic-release). You\ncan see it on the [releases page](../../releases).\n" }, { "path": "generators/app/templates/CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, religion, or sexual identity and\norientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.\n\n## Our Standards\n\nExamples of behavior that contributes to a positive environment for our\ncommunity include:\n\n- Demonstrating empathy and kindness toward other people\n- Being respectful of differing opinions, viewpoints, and experiences\n- Giving and gracefully accepting constructive feedback\n- Accepting responsibility and apologizing to those affected by our mistakes,\n and learning from the experience\n- Focusing on what is best not just for us as individuals, but for the overall\n community\n\nExamples of unacceptable behavior include:\n\n- The use of sexualized language or imagery, and sexual attention or advances of\n any kind\n- Trolling, insulting or derogatory comments, and personal or political attacks\n- Public or private harassment\n- Publishing others' private information, such as a physical or email address,\n without their explicit permission\n- Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Enforcement Responsibilities\n\nCommunity leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.\n\n## Scope\n\nThis Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at\nme+coc@kentcdodds.com. All complaints will be reviewed and investigated promptly\nand fairly.\n\nAll community leaders are obligated to respect the privacy and security of the\nreporter of any incident.\n\n## Enforcement Guidelines\n\nCommunity leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:\n\n### 1. Correction\n\n**Community Impact**: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.\n\n### 2. Warning\n\n**Community Impact**: A violation through a single incident or series of\nactions.\n\n**Consequence**: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or permanent\nban.\n\n### 3. Temporary Ban\n\n**Community Impact**: A serious violation of community standards, including\nsustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.\n\n### 4. Permanent Ban\n\n**Community Impact**: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within the\ncommunity.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage],\nversion 2.0, available at\nhttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.\n\nCommunity Impact Guidelines were inspired by\n[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see the FAQ at\nhttps://www.contributor-covenant.org/faq. Translations are available at\nhttps://www.contributor-covenant.org/translations.\n" }, { "path": "generators/app/templates/CONTRIBUTING.md", "content": "# Contributing\n\nThanks for being willing to contribute!\n\n**Working on your first Pull Request?** You can learn how from this _free_\nseries [How to Contribute to an Open Source Project on GitHub][egghead]\n\n## Project setup\n\n1. Fork and clone the repo\n2. Run `npm run setup -s` to install dependencies and run validation\n3. Create a branch for your PR with `git checkout -b pr/your-branch-name`\n\n> Tip: Keep your `main` branch pointing at the original repository and make pull\n> requests from branches on your fork. To do this, run:\n>\n> ```\n> git remote add upstream https://github.com/kentcdodds/<%= moduleName %>\n> git fetch upstream\n> git branch --set-upstream-to=upstream/main main\n> ```\n>\n> This will add the original repository as a \"remote\" called \"upstream,\" Then\n> fetch the git information from that remote, then set your local `main` branch\n> to use the upstream main branch whenever you run `git pull`. Then you can make\n> all of your pull request branches based on this `main` branch. Whenever you\n> want to update your version of `main`, do a regular `git pull`.\n\n## Committing and Pushing changes\n\nPlease make sure to run the tests before you commit your changes. You can run\n`npm run test:update` which will update any snapshots that need updating. Make\nsure to include those changes (if they exist) in your commit.\n\n## Help needed\n\nPlease checkout the [the open issues][issues]\n\nAlso, please watch the repo and respond to questions/bug reports/feature\nrequests! Thanks!\n\n\n[egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github\n[issues]: https://github.com/kentcdodds/<%= moduleName %>/issues\n\n" }, { "path": "generators/app/templates/LICENSE", "content": "The MIT License (MIT)\nCopyright (c) 2020 Kent C. Dodds\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "generators/app/templates/README.md", "content": "
\n

<%= moduleName %>

\n\n

<%= description %>

\n
\n\n---\n\n\n[![Build Status][build-badge]][build]\n[![Code Coverage][coverage-badge]][coverage]\n[![version][version-badge]][package]\n[![downloads][downloads-badge]][npmtrends]\n[![MIT License][license-badge]][license]\n[![All Contributors][all-contributors-badge]](#contributors-)\n[![PRs Welcome][prs-badge]][prs]\n[![Code of Conduct][coc-badge]][coc]\n\n\n## The problem\n\n// TODO\n\n## This solution\n\n// TODO\n\n## Table of Contents\n\n\n\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Inspiration](#inspiration)\n- [Other Solutions](#other-solutions)\n- [Issues](#issues)\n - [πŸ› Bugs](#-bugs)\n - [πŸ’‘ Feature Requests](#-feature-requests)\n- [Contributors ✨](#contributors-)\n- [LICENSE](#license)\n\n\n\n## Installation\n\nThis module is distributed via [npm][npm] which is bundled with [node][node] and\nshould be installed as one of your project's <% if (devDep) {\n%>`devDependencies`<% } %><% if (!devDep) { %>`dependencies`<% } %>:\n\n```\nnpm install --save<% if (devDep) { %>-dev<% } %> <%= moduleName %>\n```\n\n## Usage\n\n// TODO\n\n## Inspiration\n\n// TODO\n\n## Other Solutions\n\nI'm not aware of any, if you are please [make a pull request][prs] and add it\nhere!\n\n## Issues\n\n_Looking to contribute? Look for the [Good First Issue][good-first-issue]\nlabel._\n\n### πŸ› Bugs\n\nPlease file an issue for bugs, missing documentation, or unexpected behavior.\n\n[**See Bugs**][bugs]\n\n### πŸ’‘ Feature Requests\n\nPlease file an issue to suggest new features. Vote on feature requests by adding\na πŸ‘. This helps maintainers prioritize what to work on.\n\n[**See Feature Requests**][requests]\n\n## Contributors ✨\n\nThanks goes to these people ([emoji key][emojis]):\n\n\n\n\n\n \n \n \n
\"Kent
Kent C. Dodds
/commits?author=kentcdodds\" title=\"Code\">πŸ’» /commits?author=kentcdodds\" title=\"Documentation\">πŸ“– πŸš‡ /commits?author=kentcdodds\" title=\"Tests\">⚠️
\n\n\n\n\n\n\nThis project follows the [all-contributors][all-contributors] specification.\nContributions of any kind welcome!\n\n## LICENSE\n\nMIT\n\n\n[npm]: https://www.npmjs.com\n[node]: https://nodejs.org\n[build-badge]: https://img.shields.io/github/workflow/status/kentcdodds/<%= moduleName %>/validate?logo=github&style=flat-square\n[build]: https://github.com/kentcdodds/<%= moduleName %>/actions?query=workflow%3Avalidate\n[coverage-badge]: https://img.shields.io/codecov/c/github/kentcdodds/<%= moduleName %>.svg?style=flat-square\n[coverage]: https://codecov.io/github/kentcdodds/<%= moduleName %>\n[version-badge]: https://img.shields.io/npm/v/<%= moduleName %>.svg?style=flat-square\n[package]: https://www.npmjs.com/package/<%= moduleName %>\n[downloads-badge]: https://img.shields.io/npm/dm/<%= moduleName %>.svg?style=flat-square\n[npmtrends]: https://www.npmtrends.com/<%= moduleName %>\n[license-badge]: https://img.shields.io/npm/l/<%= moduleName %>.svg?style=flat-square\n[license]: https://github.com/kentcdodds/<%= moduleName %>/blob/main/LICENSE\n[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\n[prs]: https://makeapullrequest.com\n[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square\n[coc]: https://github.com/kentcdodds/<%= moduleName %>/blob/main/CODE_OF_CONDUCT.md\n[emojis]: https://github.com/all-contributors/all-contributors#emoji-key\n[all-contributors]: https://github.com/all-contributors/all-contributors\n[all-contributors-badge]: https://img.shields.io/github/all-contributors/kentcdodds/<%= moduleName %>?color=orange&style=flat-square\n[bugs]: https://github.com/kentcdodds/<%= moduleName %>/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Acreated-desc+label%3Abug\n[requests]: https://github.com/kentcdodds/<%= moduleName %>/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement\n[good-first-issue]: https://github.com/kentcdodds/<%= moduleName %>/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement+label%3A%22good+first+issue%22\n\n" }, { "path": "generators/app/templates/_package.json", "content": "{\n \"name\": \"<%= moduleName %>\",\n \"version\": \"0.0.0-semantically-released\",\n \"description\": \"<%= description %>\",\n \"main\": \"dist/index.js\",\n \"types\": \"dist/index.d.ts\",\n \"keywords\": [],\n \"author\": \"Kent C. Dodds (https://kentcdodds.com)\",\n \"license\": \"MIT\",\n \"engines\": {\n \"node\": \">=12\",\n \"npm\": \">=6\"\n },\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/kentcdodds/<%= moduleName %>\"\n },\n \"bugs\": {\n \"url\": \"https://github.com/kentcdodds/<%= moduleName %>/issues\"\n },\n \"homepage\": \"https://github.com/kentcdodds/<%= moduleName %>#readme\",\n \"files\": [\n \"dist\"\n ],\n \"scripts\": {\n \"build\": \"kcd-scripts build\",\n \"lint\": \"kcd-scripts lint\",\n \"setup\": \"npm install && npm run validate -s\",\n \"test\": \"kcd-scripts test\",\n \"test:update\": \"npm test -- --updateSnapshot --coverage\",\n \"typecheck\": \"kcd-scripts typecheck\",\n \"validate\": \"kcd-scripts validate\"\n },\n \"dependencies\": {\n \"@babel/runtime\": \"^7.14.6\"\n },\n \"devDependencies\": {\n \"@types/jest\": \"^26.0.24\",\n \"kcd-scripts\": \"^11.1.0\",\n \"typescript\": \"^4.3.5\"\n },\n \"eslintConfig\": {\n \"extends\": \"./node_modules/kcd-scripts/eslint.js\"\n },\n \"eslintIgnore\": [\n \"node_modules\",\n \"coverage\",\n \"dist\"\n ]\n}\n" }, { "path": "generators/app/templates/all-contributorsrc", "content": "{\n \"projectName\": \"<%= moduleName %>\",\n \"projectOwner\": \"kentcdodds\",\n \"imageSize\": 100,\n \"commit\": false,\n \"contributorsPerLine\": 7,\n \"repoHost\": \"https://github.com\",\n \"repoType\": \"github\",\n \"skipCi\": false,\n \"files\": [\n \"README.md\"\n ],\n \"contributors\": [\n {\n \"login\": \"kentcdodds\",\n \"name\": \"Kent C. Dodds\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/1500684?v=3\",\n \"profile\": \"https://kentcdodds.com\",\n \"contributions\": [\n \"code\",\n \"doc\",\n \"infra\",\n \"test\"\n ]\n }\n ]\n}\n" }, { "path": "generators/app/templates/gitattributes", "content": "* text=auto eol=lf\n" }, { "path": "generators/app/templates/github/ISSUE_TEMPLATE.md", "content": "\n\n- `<%= moduleName %>` version:\n- `node` version:\n- `npm` version:\n\nRelevant code or config\n\n```js\n\n```\n\nWhat you did:\n\nWhat happened:\n\n\n\nReproduction repository:\n\n\n\nProblem description:\n\nSuggested solution:\n" }, { "path": "generators/app/templates/github/PULL_REQUEST_TEMPLATE.md", "content": "\n\n\n\n**What**:\n\n\n\n**Why**:\n\n\n\n**How**:\n\n\n\n**Checklist**:\n\n\n\n\n- [ ] Documentation\n- [ ] Tests\n- [ ] Ready to be merged\n \n\n\n" }, { "path": "generators/app/templates/github/workflows/validate.yml", "content": "name: validate\non:\n push:\n branches:\n - '+([0-9])?(.{+([0-9]),x}).x'\n - 'main'\n - 'next'\n - 'next-major'\n - 'beta'\n - 'alpha'\n - '!all-contributors/**'\n pull_request: {}\njobs:\n main:\n # ignore all-contributors PRs\n if: ${{ !contains(github.head_ref, 'all-contributors') }}\n strategy:\n matrix:\n node: [12, 14, 16]\n runs-on: ubuntu-latest\n steps:\n - name: πŸ›‘ Cancel Previous Runs\n uses: styfle/cancel-workflow-action@0.9.0\n\n - name: ⬇️ Checkout repo\n uses: actions/checkout@v2\n\n - name: βŽ” Setup node\n uses: actions/setup-node@v2\n with:\n node-version: ${{ matrix.node }}\n\n - name: πŸ“₯ Download deps\n uses: bahmutov/npm-install@v1\n with:\n useLockFile: false\n env:\n HUSKY_SKIP_INSTALL: true\n\n - name: ▢️ Run validate script\n run: npm run validate\n\n - name: ⬆️ Upload coverage report\n uses: codecov/codecov-action@v2\n\n release:\n needs: main\n runs-on: ubuntu-latest\n if:\n ${{ github.repository == 'kentcdodds/<%= moduleName %>' &&\n contains('refs/heads/main,refs/heads/beta,refs/heads/next,refs/heads/alpha',\n github.ref) && github.event_name == 'push' }}\n steps:\n - name: πŸ›‘ Cancel Previous Runs\n uses: styfle/cancel-workflow-action@0.9.0\n\n - name: ⬇️ Checkout repo\n uses: actions/checkout@v2\n\n - name: βŽ” Setup node\n uses: actions/setup-node@v2\n with:\n node-version: 14\n\n - name: πŸ“₯ Download deps\n uses: bahmutov/npm-install@v1\n with:\n useLockFile: false\n env:\n HUSKY_SKIP_INSTALL: true\n\n - name: πŸ— Run build script\n run: npm run build\n\n - name: πŸš€ Release\n uses: cycjimmy/semantic-release-action@v2\n with:\n semantic_version: 17\n branches: |\n [\n '+([0-9])?(.{+([0-9]),x}).x',\n 'main',\n 'next',\n 'next-major',\n {name: 'beta', prerelease: true},\n {name: 'alpha', prerelease: true}\n ]\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n" }, { "path": "generators/app/templates/gitignore", "content": "node_modules\ncoverage\ndist\n.DS_Store\n\n# these cause more harm than good\n# when working with contributors\npackage-lock.json\nyarn.lock\n" }, { "path": "generators/app/templates/huskyrc.js", "content": "module.exports = require('kcd-scripts/husky')\n" }, { "path": "generators/app/templates/npmrc", "content": "package-lock=false\n" }, { "path": "generators/app/templates/other/MAINTAINING.md", "content": "# Maintaining\n\n\n\n\n**Table of Contents**\n\n- [Code of Conduct](#code-of-conduct)\n- [Issues](#issues)\n- [Pull Requests](#pull-requests)\n- [Release](#release)\n- [Thanks!](#thanks)\n\n\n\nThis is documentation for maintainers of this project.\n\n## Code of Conduct\n\nPlease review, understand, and be an example of it. Violations of the code of\nconduct are taken seriously, even (especially) for maintainers.\n\n## Issues\n\nWe want to support and build the community. We do that best by helping people\nlearn to solve their own problems. We have an issue template and hopefully most\nfolks follow it. If it's not clear what the issue is, invite them to create a\nminimal reproduction of what they're trying to accomplish or the bug they think\nthey've found.\n\nOnce it's determined that a code change is necessary, point people to\n[makeapullrequest.com](https://makeapullrequest.com) and invite them to make a\npull request. If they're the one who needs the feature, they're the one who can\nbuild it. If they need some hand holding and you have time to lend a hand,\nplease do so. It's an investment into another human being, and an investment\ninto a potential maintainer.\n\nRemember that this is open source, so the code is not yours, it's ours. If\nsomeone needs a change in the codebase, you don't have to make it happen\nyourself. Commit as much time to the project as you want/need to. Nobody can ask\nany more of you than that.\n\n## Pull Requests\n\nAs a maintainer, you're fine to make your branches on the main repo or on your\nown fork. Either way is fine.\n\nWhen we receive a pull request, a GitHub Action is kicked off automatically (see\nthe `.github/workflows/validate.yml` for what runs in the Action). We avoid\nmerging anything that breaks the GitHub Action.\n\nPlease review PRs and focus on the code rather than the individual. You never\nknow when this is someone's first ever PR and we want their experience to be as\npositive as possible, so be uplifting and constructive.\n\nWhen you merge the pull request, 99% of the time you should use the\n[Squash and merge](https://help.github.com/articles/merging-a-pull-request/)\nfeature. This keeps our git history clean, but more importantly, this allows us\nto make any necessary changes to the commit message so we release what we want\nto release. See the next section on Releases for more about that.\n\n## Release\n\nOur releases are automatic. They happen whenever code lands into `main`. A\nGitHub Action gets kicked off and if it's successful, a tool called\n[`semantic-release`](https://github.com/semantic-release/semantic-release) is\nused to automatically publish a new release to npm as well as a changelog to\nGitHub. It is only able to determine the version and whether a release is\nnecessary by the git commit messages. With this in mind, **please brush up on\n[the commit message convention][commit] which drives our releases.**\n\n> One important note about this: Please make sure that commit messages do NOT\n> contain the words \"BREAKING CHANGE\" in them unless we want to push a major\n> version. I've been burned by this more than once where someone will include\n> \"BREAKING CHANGE: None\" and it will end up releasing a new major version. Not\n> a huge deal honestly, but kind of annoying...\n\n## Thanks!\n\nThank you so much for helping to maintain this project!\n\n\n[commit]: https://github.com/conventional-changelog-archived-repos/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md\n\n" }, { "path": "generators/app/templates/other/USERS.md", "content": "# Users\n\nIf you or your company uses this project, add your name to this list! Eventually\nwe may have a website to showcase these (wanna build it!?)\n\n> No users have been added yet!\n\n\n" }, { "path": "generators/app/templates/other/manual-releases.md", "content": "# manual-releases\n\nThis project has an automated release set up. So things are only released when\nthere are useful changes in the code that justify a release. But sometimes\nthings get messed up one way or another and we need to trigger the release\nourselves. When this happens, simply bump the number below and commit that with\nthe following commit message based on your needs:\n\n**Major**\n\n```\nfix(release): manually release a major version\n\nThere was an issue with a major release, so this manual-releases.md\nchange is to release a new major version.\n\nReference: #\n\nBREAKING CHANGE: \n```\n\n**Minor**\n\n```\nfeat(release): manually release a minor version\n\nThere was an issue with a minor release, so this manual-releases.md\nchange is to release a new minor version.\n\nReference: #\n```\n\n**Patch**\n\n```\nfix(release): manually release a patch version\n\nThere was an issue with a patch release, so this manual-releases.md\nchange is to release a new patch version.\n\nReference: #\n```\n\nThe number of times we've had to do a manual release is: 0\n" }, { "path": "generators/app/templates/prettierignore", "content": "node_modules\ncoverage\ndist\n" }, { "path": "generators/app/templates/prettierrc.js", "content": "module.exports = require('kcd-scripts/prettier')\n" }, { "path": "generators/app/templates/src/__tests__/index.ts", "content": "// TODO: test the library\n" }, { "path": "generators/app/templates/src/index.ts", "content": "// TODO: let's build something amazing...\n" }, { "path": "generators/app/templates/tsconfig.json", "content": "{\n \"extends\": \"./node_modules/kcd-scripts/shared-tsconfig.json\"\n}\n" }, { "path": "package.json", "content": "{\n \"name\": \"generator-kcd-oss\",\n \"version\": \"0.0.0-semantically-released\",\n \"description\": \"A generator for my projects. Feel free to contribute if you want to adapt it for more use cases\",\n \"keywords\": [\n \"open source\",\n \"kentcdodds\",\n \"yeoman-generator\"\n ],\n \"author\": \"Kent C. Dodds (https://kentcdodds.com)\",\n \"license\": \"MIT\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/kentcdodds/generator-kcd-oss\"\n },\n \"bugs\": {\n \"url\": \"https://github.com/kentcdodds/generator-kcd-oss/issues\"\n },\n \"homepage\": \"https://github.com/kentcdodds/generator-kcd-oss#readme\",\n \"files\": [\n \"generators\"\n ],\n \"scripts\": {\n \"lint\": \"kcd-scripts lint\",\n \"setup\": \"npm install && npm run validate -s\",\n \"validate\": \"kcd-scripts validate\"\n },\n \"dependencies\": {\n \"lodash.kebabcase\": \"^4.1.1\",\n \"npm-check\": \"^5.9.2\",\n \"yeoman-generator\": \"^4.13.0\"\n },\n \"devDependencies\": {\n \"kcd-scripts\": \"^11.1.0\"\n },\n \"eslintConfig\": {\n \"extends\": \"./node_modules/kcd-scripts/eslint.js\"\n },\n \"eslintIgnore\": [\n \"node_modules\",\n \"coverage\",\n \"dist\",\n \"generators/app/templates/src\"\n ],\n \"engines\": {\n \"node\": \">=12\",\n \"npm\": \">=6\"\n }\n}\n" } ]