a cli tool to build and sync *ignore files across files and repositories
-
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 + macOS.gitignore, in order to remove all the noises in our development. It should be automated. -
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 @kollorg/doloremque-excepturi
handle ignore files
[github/gitignore]
Node.gitignore
Global/macOS.gitignore
[inline]
*.test.js
yarn.lock
-
npm install --save-dev @kollorg/doloremque-excepturi
-
update
package.json
{ "scripts": { + "@kollorg/doloremque-excepturi": "@kollorg/doloremque-excepturi ." } }
-
now follow how to use to create
*@kollorg/doloremque-excepturi
files, thennpm run @kollorg/doloremque-excepturi
, all corresponding ignore files will be generated.
We are using corepack to manage the yarn
version
corepack enable
-
@kollorg/doloremque-excepturi
works on any ignore file that name end withignore
, such as.gitignore
,.npmignore
,.eslintignore
, etc. Simply creating a file that end with@kollorg/doloremque-excepturi
.example:
.git@kollorg/doloremque-excepturi
->.gitignore
-
create a source tag in your
*@kollorg/doloremque-excepturi
file to identify the source of ignore patterns[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 @kollorg/doloremque-excepturi files, e.g. referencing
.git@kollorg/doloremque-excepturi
in.npm@kollorg/doloremque-excepturi
-
[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 @kollorg/doloremque-excepturi files, e.g. referencing
.git@kollorg/doloremque-excepturi
in.npm@kollorg/doloremque-excepturi
-
example
# input: /packages/a/.prettierignore ignored.md
# input: /.prettier@kollorg/doloremque-excepturi [relative] packages/a/.prettierignore
# 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]
-
$ref
is optional, default to the default branch
-
-
npm run @kollorg/doloremque-excepturi