Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Kikobeats/untracked
Universal way for ignoring unnecessary common files to fit your bundle
https://github.com/Kikobeats/untracked
gitignore prune
Last synced: 3 months ago
JSON representation
Universal way for ignoring unnecessary common files to fit your bundle
- Host: GitHub
- URL: https://github.com/Kikobeats/untracked
- Owner: Kikobeats
- License: mit
- Created: 2017-12-23T23:32:36.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-08T08:28:35.000Z (6 months ago)
- Last Synced: 2024-07-10T15:22:01.805Z (4 months ago)
- Topics: gitignore, prune
- Language: JavaScript
- Homepage: https://nicedoc.io/kikobeats/untracked
- Size: 349 KB
- Stars: 30
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# untracked
[](https://www.npmjs.org/package/untracked)
**untracked** is a universal way for ingnoring unnecessary common files (such as `README.md`, `LICENSE.md`, `Makefile`, `Gruntfile`, `Gulpfile`, `karma.conf.js`, etc) to fit your bundle and create **smallest production ready bunddle** possible.
## Usage
Just run the command
```
npx untracked
```
The files to ignore will be detected automagically ✨.
### Using with Heroku
You need to write the output as [`.slugignore`](https://devcenter.heroku.com/articles/slug-compiler#ignoring-files-with-slugignore).
For doing that you can run the command directly
```
npx untracked > .slugignore
```
Also, you can declare it as [`heroku-prebuild`](https://devcenter.heroku.com/articles/nodejs-support#heroku-specific-build-steps) at `scripts` in your `package.json`:
```json
{
"scripts": {
"heroku-prebuild": "npx untracked > .slugignore"
}
}
```
### Using with Vercel
Just you need to write the output at [`.vercelignore`](https://vercel.com/docs/concepts/deployments/vercel-ignore) file.
```
npx untracked > .vercelignore
```
### Using with Yarn
[Yarn](https://yarnpkg.com) supports remove unnecessary files via [`.yarnclean`](https://yarnpkg.com/en/docs/cli/autoclean).
```bash
yarn install --production
npx untracked > .yarnclean
yarn autoclean --force
```
### Using with Docker
Just you need to write the output at [`.dockerignore`](https://docs.docker.com/engine/reference/builder/#dockerignore-file) file.
```
npx untracked > .dockerignore
```
## Additional Files
Sometimes you need to declare an extra file to include/ignore in the bundle.
That's could be achieve just declaring a `untracked` field into your `package.json`:
```json
{
"untracked": {
"whitelist": [
"bin"
],
"blacklist": [
"bench",
"node_modules/@ffprobe-installer/darwin-x64",
"node_modules/@ffprobe-installer/linux-ia32",
"node_modules/@ffprobe-installer/win32-ia32",
"node_modules/@ffprobe-installer/win32-x64",
"node_modules/puppeteer/.local-chromium",
"scripts"
]
}
}
```
If you need to declare this files programatically, you can use any of the [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) supported ways for loading the configuration.
## How It Works™
**untracked** create a list of common files to ignore using [gitignore pattern format](https://git-scm.com/docs/gitignore#_pattern_format).
This makes it compatible with any builder process that supports ignore files based on this pattern declaration.
Under the hood, **untracked** supports file name variations for files such as
- Documentation (`docs`, `LICENSE`, `README`, etc).
- Toolings configuration (`Makefile`, `Gruntfile`, `Gulpfile`, `karma.conf.js`,etc).
- Assets (`*.map`, `*.d.ts`, `*.flow`, etc).
It creates the properly gitpattern for ignoring any of these files.
## Related
- [lambda-prune](https://github.com/Kikobeats/lambda-prune) – Cleanup old AWS Lambda functions.
- [node-prune](https://github.com/tj/node-prune) – Remove unnecessary files from node_modules (.md, .ts, ...).
- [lambdapack](https://github.com/toriihq/lambdapack) – Package your AWS Lambda efficiently.
## License
**untracked** © [Kiko Beats](https://kikobeats.com), released under the [MIT](https://github.com/Kikobeats/untracked/blob/master/LICENSE.md) License.
Authored and maintained by Kiko Beats with help from [contributors](https://github.com/Kikobeats/untracked/contributors).
> [kikobeats.com](https://kikobeats.com) · GitHub [@Kiko Beats](https://github.com/Kikobeats) · Twitter [@Kikobeats](https://twitter.com/Kikobeats)