Miss any of our Open RFC calls?Watch the recordings here! »

@ianwremmel/create

2.2.4 • Public • Published

@ianwremmel/proj

license standard-readme compliant

Dependabot badge dependencies Status devDependencies Status semantic-release

CircleCI Coverage Status

Rig up projects on GitHub/CircleCI

I got tired of going through the same set of steps to create a repo, tweak package.json, connect circle ci, and whatnot, so, this automates that process according to my preferences.

Install

Since this project is intentded for use with npm init, there's generally no need to install it.

npm install -g @ianwremmel/create

Usage

npm init @ianwremmel

Without options, the default behavior is:

  • create a github repository
  • initialize local repository
  • create root commit
  • connect local repo to github repo
  • follow project on circle ci and configure project settings
  • create common project files and install dev dependencies
    • .circleci/config.yml
    • .editorconfig
    • .eslintrc.yml
    • .gitignore
    • .markdownlint
    • .prettierrc
    • .prettierignore
    • .npmrc
    • LICENSE
    • README.md
    • commitlint.config.js
    • package.json
  • generate npm scripts
  • push local commits to github
  • setup branch protection
  • Follow project with dependabot

Options

  • --public: Make the GitHub repo a public repo.
  • --local-only: Only scaffold the project locally; do not set up GitHub or services (Note: this flag is not well tested).

Maintainers

ianwremmel

Contribute

See CONTRIBUTE

License

© MIT

Keywords

none

Install

npm i @ianwremmel/[email protected]

Version

2.2.4

License

MIT

Unpacked Size

52.5 kB

Total Files

36

Last publish

Collaborators

  • avatar