https://github.com/foray1010/ignore-sync

a CLI tool to build and sync .*ignore files across files and repositories
https://github.com/foray1010/ignore-sync

cli dockerignore eslintignore git gitignore gitignore-files gitignore-generator gitignore-templates ignore ignore-files npmignore

Last synced: 7 days ago
JSON representation

a CLI tool to build and sync .*ignore files across files and repositories

• Host: GitHub
• URL: https://github.com/foray1010/ignore-sync
• Owner: foray1010
• License: mit
• Created: 2017-11-15T14:25:09.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2025-01-28T01:47:58.000Z (8 days ago)
• Last Synced: 2025-01-28T02:53:49.305Z (8 days ago)
• Topics: cli, dockerignore, eslintignore, git, gitignore, gitignore-files, gitignore-generator, gitignore-templates, ignore, ignore-files, npmignore
• Language: JavaScript
• Homepage:
• Size: 4.54 MB
• Stars: 30
• Watchers: 4
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ignore-sync

a cli tool to build and sync \*ignore files across files and repositories

## Why

1. Github default `.gitignore` doesn't cover all our needs, we always need to compose and manage multiple `.gitignore` files from github, such as [Node.gitignore](https://github.com/github/gitignore/blob/main/Node.gitignore) + [macOS.gitignore](https://github.com/github/gitignore/blob/main/Global/macOS.gitignore), in order to remove all the noises in our development. It should be automated.

1. For library developer, we often need to compose a `.npmignore` from `.gitignore` and some extra ignore patterns that we do not wish to ignore by `.gitignore`, such as test files and `.*rc` files. If `.gitignore` is updated, you will need to update corresponding part of `.npmignore` manually. We should avoid this repetitive work.

a short example on how `ignore-sync` handle ignore files

```ini

[github/gitignore]

Node.gitignore

Global/macOS.gitignore

[inline]

*.test.js

yarn.lock

```

## Installation and setup

1. `npm install --save-dev ignore-sync`

1. update `package.json`

   ```diff json

   {

     "scripts": {

   +   "ignore-sync": "ignore-sync ."

     }

   }

   ```

1. now follow [how to use](#how-to-use) to create `*ignore-sync` files, then `npm run ignore-sync`, all corresponding ignore files will be generated.

## Development Setup

We are using [corepack](https://nodejs.org/api/corepack.html) to manage the `yarn` version

```bash

corepack enable

```

## How to use

1. `ignore-sync` works on any ignore file that name end with `ignore`, such as `.gitignore`, `.npmignore`, `.eslintignore`, etc. Simply creating a file that end with `ignore-sync`.

   example: `.gitignore-sync` -> `.gitignore`

1. create a source tag in your `*ignore-sync` file to identify the source of ignore patterns

   ```ini

   [put_source_tag_here]

   ```

   different source tag identifies different source of ignore patterns

   - `[inline]`

     - the ignore patterns will be copied directly to generated ignore file

   - `[local]`

     - the content of these local files will be copied directly to generated ignore file

     - support glob pattern, e.g. `packages/**/.gitignore`

     - support referencing other ignore-sync files, e.g. referencing `.gitignore-sync` in `.npmignore-sync`

   - `[relative]`

     - the content of these local files will be copied with **relative path prefix** to generated ignore file

     - support glob pattern, e.g. `packages/**/.gitignore`

     - support referencing other ignore-sync files, e.g. referencing `.gitignore-sync` in `.npmignore-sync`

     - example

       ```ini

       # input: /packages/a/.prettierignore

       ignored.md

       ```

       ```ini

       # input: /.prettierignore-sync

       [relative]

       packages/a/.prettierignore

       ```

       ```ini

       # output: /.prettierignore

       packages/a/ignored.md

       ```

   - `[$username/$repo#$ref]`

     - the content of these github files will be downloaded and appended to generated ignore file

     - recommend using ignore patterns from [\[github/gitignore\]](https://github.com/github/gitignore)

     - `$ref` is optional, default to the default branch

1. `npm run ignore-sync`