Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/confused-techie/compactignore
Single file configuration for your Code Exclusions.
https://github.com/confused-techie/compactignore
build-tool dockerignore eslintignore gitignore javascript npmignore prettierignore
Last synced: 2 months ago
JSON representation
Single file configuration for your Code Exclusions.
- Host: GitHub
- URL: https://github.com/confused-techie/compactignore
- Owner: confused-Techie
- License: mit
- Created: 2022-02-02T06:10:21.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-18T14:54:56.000Z (6 months ago)
- Last Synced: 2024-09-19T20:18:40.416Z (3 months ago)
- Topics: build-tool, dockerignore, eslintignore, gitignore, javascript, npmignore, prettierignore
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@confused-techie/compactignore
- Size: 890 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGE_LOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# CompactIgnore
> Single file configuration for your Code Exclusions.
.gitignore - .dockerignore - .prettierignore - .npmignore - .eslintignore - .gcloudignore
[](https://www.codacy.com/gh/confused-Techie/CompactIgnore/dashboard?utm_source=github.com&utm_medium=referral&utm_content=confused-Techie/CompactIgnore&utm_campaign=Badge_Grade)
[](https://github.com/prettier/prettier)
[](https://codecov.io/gh/confused-Techie/CompactIgnore)
[](https://github.com/confused-Techie/CompactIgnore/actions/workflows/ci-standards.yml)
[](https://github.com/confused-Techie/CompactIgnore/actions/workflows/ci-tests.yml)
CompactIgnore is a single file configuration tool aimed at helping to reduce the overhead and allow easy consistency across ignore files.
By creating a `.compactignore` file, it will be able to generate any supported ignore file specified with their own custom entries or inheriting others.
# Installation
To start using CompactIgnore install the package, either Globally or as a Dev Dependency:
Globally:
```shell
npm install @confused-techie/compactignore -g
```
Dev-Dependency:
```shell
npm install @confused-techie/compactignore -D
```
Once installed you'll need to create you `.compactignore` file, [more on that below](#usage), now it's time to use CompactIgnore.
To generate your ignore files the command needed will depend on your installation.
Globally:
Just run `compactignore` in the same directory that includes your `.compactignore` file.
Dev-Dependency:
If you include CompactIgnore in your package, it's recommended to add the following snippet to your `package.json`s `scripts`.
```json
"scripts": {
"ignore": "compactignore"
}
```
Then when needed you can run `npm run ignore` to regenerate your ignore files.
# Usage
When creating your `.compactignore` file it's good to know that generally all rules are based around the `.gitignore` file. With some notably exclusions.
CompactIgnore uses Profiles to determine what kind of ignore file to generate as well as using Profiles to separate what entries to include in each file.
The key values to remember:
- `>` is a profile declarator line. This character should be followed by the profile you plan to use for this file.
- `!` means to include this file in your ignore file, similar to how this will include the file when used in a gitignore
- `#` means this line is a comment. It will be included in the final ignore files
- Having no special character in front of a line will then go ahead and exclude that line from the ignore file.
- To escape any characters use `\`
- Each entry must be on it's one line
# Examples
To create the following files:
#### `.gitignore`
```text
/node_modules
/secrets.json
```
#### `.dockerignore`
```text
/node_modules
/secrets.json
.gitignore
.gitattributes
```
You just need to create the following `.compactignore` file to accomplish the same.
#### `.compactignore`
```text
> GLOBAL
/node_modules
/secrets.json
> dockerignore
.gitignore
.gitattributes
```
Remember if you ever want to generate an additional ignore that includes only the `GLOBAL` Profile entries you can add `> profile_name` with no special entries and it will be generated containing only the `GLOBAL` Profile entries.
If you'd like, [here's](https://github.com/confused-Techie/CompactIgnore/tree/main/examples) a more complicated example.
# Profiles
The following profiles are supported:
- `GLOBAL`|`global`: This profile will apply all entries globally to each other ignore file that is created.
- `dockerignore`: This profile will generate a `.dockerignore` file.
- `eslintignore`: This profile will generate a `.eslintignore` file.
- `gitignore`: This profile will generate a `.gitignore` file.
- `npmignore`: This profile will generate a `.npmignore` file.
- `prettierignore`: This profile will generate a `.prettierignore` file.
- `gcloudignore`: This profile will generate a `.gcloudignore` file.
# Why use CompactIgnore
CompactIgnore is made for those developers who end up having to maintain several ignore files in a single codebase.
Say for example your project is uploaded to a Git Repository, uses Prettier to make your code readable, uses ESLint to ensure your code meets your standards, and is published to NPM.JS
If all the above is true you need to manually keep track of `.gitignore`, `.eslintignore`, `.prettierignore`, and `.npmignore`
Which in most cases can be fine if their configuration is simple, or your project doesn't contain anything that shouldn't be uploaded. But say now in your repo you add `.env` or `secrets.json` or some other file that contains sensitive configuration details or private API keys you need to double or triple check that these are added to every single file, and ensure they all work properly. But with CompactIgnore it can now be as easy as adding it to your `GLOBAL` Profile, and generating all your ignore files right away.
# Documentation
- [Examples](examples/)
- [Structures.md](docs/structures.md)
- [Change Log](CHANGE_LOG.md)
# Contribute
See [CONTRIBUTING.md](CONTRIBUTING.md).