Giter Club home page Giter Club logo

carpent's Introduction

๐Ÿ”จ Carpent

Bootstrap and configure any project using its template -- clone a repository, update data using variables, and more.

Node CI Travis CI Coverage Dependencies License Vulnerabilities Based on Carpent npm type definitions npm package npm downloads Contributors semantic-release

npm

๐Ÿ’ก Usage

If you want to quickly bootstrap a project, use npx:

npx carpent

Example screen recording

Alternately, you can install the package globally from npm:

npm install --global carpent

Use the CLI:

carpet

Or, import and use the API:

import { carpet } from "carpet";

carpet({
  repo: "https://github.com/AnandChowdhary/carpet",
  // ...all configuration options here (see API Configuration)
});

Setting up Carpent with your template

If you're building a template repository that others can use, you can add Carpent by creating a .carpentrc file in the root with the following schema:

{
  "questions": [], // Configuration questions to ask
  "deleteFiles": [], // List of files to delete
  "beforeAll": [], // Scripts to run before process
  "afterAll": [] // Scripts to run after process
}

For example:

{
  "deleteFiles": [".carpentrc"], // Delete the .carpentrc file
  "questions": [
    {
      "name": "name", // `name` is required in each input
      "type": "input", // Let users type an input response
      "message": "Project name", // Ask them this question
      "files": ["package.json"], // Update the package.json file
      "jsonKey": "name" // Change the `name` key in package.json
    }
  ],
  "afterAll": ["echo 'Completed!'"] // Run this script at the end
}

Each question under questions support the following properties:

Property Description
name (required) Internal name for question
type (required) One of Inquirer.js's question types
message (required) Question to ask the user
default Default value for this answer
choices Let users select one of these options
files Update these files
jsonKey Update this JSON key
find Find this value for replacing
replace Repace with this value

API Configuration

You can specify a key-value pair as the API parameter with the following properties:

Property Description Default
repo Git repository URL Required
dir Path to directory to create "carpent"
license License MIT License
licenseName Full name for license
initializeNewRepo Initialize new git repository false

๐Ÿ‘ฉโ€๐Ÿ’ป Development

Build TypeScript:

npm run build

Run unit tests and view coverage:

npm run test-without-reporting

๐Ÿ“„ License

MIT ยฉ Anand Chowdhary

carpent's People

Contributors

anandchowdhary avatar dependabot[bot] avatar semantic-release-bot avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

eduwass

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.