You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP
Socket
Book a DemoInstallSign in
Socket

create-octokit-project

Package Overview
Dependencies
Maintainers
2
Versions
125
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

create-octokit-project

`npm init` script to create a new Octokit JS module (plugin, authentication strategy, or otherwise)

5.0.0
latest
Source
npmnpm
Version published
Maintainers
2
Created
Source

Create new Octokit JS project

"npm init" script to create a new folder and repository for an Octokit JavaScript module (plugin, authentication strategy, or otherwise)

Usage

npm init octokit-project

What it does

  • Creates a new folder on your machine
  • Inits git in the new folder
  • Add LICENSE, CODE_OF_CONDUCT.md and README.md files
  • Creates a repository
  • Adds repository as git remote add origin <url>
  • Push the 3 files to main
  • Creates a new local branch called initial-version
  • Creates a package.json and package-lock.json. Installs dev dependencies.
  • Creates .gitignore, tsconfig.json
  • Creates test/smoke.test.ts
  • Creates actions for tests and automated releases
  • Creates a pull request with further instructions
  • Adds branch protection

Contribute

Pull requests welcome! My longer term goal is to make this script useful for Octokit Plugin developers.

License

MIT

Keywords

npm-init

FAQs

Package last updated on 20 May 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts