Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/io-arc/preset-setup-files

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/io-arc/preset-setup-files
Owner: io-arc
License: mit
Created: 2021-05-19T02:40:12.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2021-05-27T03:57:11.000Z (over 3 years ago)
Last Synced: 2024-11-06T18:08:37.893Z (about 2 months ago)
Language: TypeScript
Size: 229 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# Preset setup files

You can use commands to generate files that are often used in web production.

## Install

```shell
# npm
$ npm install -g @io-arc/preset-setup-files

# yarn
$ yarn add global @io-arc/preset-setup-files
```

### Supported files

- .editorconfig
- .gitignore
- .npmrc
- .npmignore
- .browserslistrc
- .prettierrc (json/json5/yaml/js/cjs/toml)
- .eslintrc (js/cjs/yaml/json)
- .eslintignore

## Usage

### Default

Execute the command in the directory where you want to set the file.

```shell
$ cd
$ preset-setup-files
```

![default preset setup files](docs/images/default.jpg)

### Custom configuration

In custom mode, you can below.

- Default choices
- Template directory to browse

Custom settings will be recorded in `.preset-setup-files-config.json` in your home directory.

```shell
$ preset-setup-files --custom
```

**Default choices**
\* Same as default command, but not copy files
![default preset setup files](docs/images/custom-choices.jpg)

**Template directory to browse**
![default preset setup files](docs/images/custom-directory.jpg)

#### Remove custom settings

Delete `.preset-setup-files-config.json`.

### See configuration

Check the current settings.

```shell
$ preset-setup-files --config
# or
$ preset-setup-files -c
```

![config](docs/images/see-config.jpg)

## Request

If you have a template you would like to see added, please suggest it in Issues.