1.1.1 ā€¢ Published 3 years ago

create-foss-files v1.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

cover

split

  • Simple: Extremely simple to use.
  • Cross-platform: Works on macOS, linux, and Windows.
  • JavaScript files: Generates additional files if you are developing a JavaScript project.
  • Prettier: Integrated prettier if the project is a JavaScript project.
  • MIT Licensed: Free to use for personal and commercial use.

šŸ“¦ Installation

# install the CLI globally
npm install -g create-foss-files

# use it with npx (recommended)
npx create-foss-files --flag

šŸš€ Usage

Create a new project folder. Navigate into it. Run any of the following command inside of it.

# if installed globally (only generates required files)
cff

# if installed globally (add JavaScript files)
cff --javascript

# with npx (only generates required files)
npx create-foss-files

# with npx (add JavaScript files)
npx create-foss-files --javascript

šŸ— Directory Structure

Directory tree with cff

ā””ā”€ā”€ [project name]
    ā”œā”€ā”€ .editorconfig
    ā”œā”€ā”€ .gitattributes
    ā”œā”€ā”€ .gitignore
    ā”œā”€ā”€ changelog.md
    ā”œā”€ā”€ code-of-conduct.md
    ā”œā”€ā”€ contributing.md
    ā”œā”€ā”€ license
    ā””ā”€ā”€ readme

Directory tree with cff --javascript

ā””ā”€ā”€ [project name]
    ā”œā”€ā”€ .editorconfig
    ā”œā”€ā”€ .gitattributes
    ā”œā”€ā”€ .gitignore
    ā”œā”€ā”€ .npmrc
    ā”œā”€ā”€ .prettierrc.json
    ā”œā”€ā”€ changelog.md
    ā”œā”€ā”€ code-of-conduct.md
    ā”œā”€ā”€ contributing.md
    ā”œā”€ā”€ index.js
    ā”œā”€ā”€ license
    ā”œā”€ā”€ package.json
    ā””ā”€ā”€ readme

šŸ‘ØšŸ»ā€šŸ’» Contributing

Make sure you read the contributing guidelines before opening a PR.

šŸ”‘ License & Conduct