1 |
|
2 |
|
3 | # IgnoreFS
|
4 |
|
5 |
|
6 |
|
7 |
|
8 |
|
9 | <span class="badge-githubworkflow"><a href="https://github.com/bevry/ignorefs/actions?query=workflow%3Abevry" title="View the status of this project's GitHub Workflow: bevry"><img src="https://github.com/bevry/ignorefs/workflows/bevry/badge.svg" alt="Status of the GitHub Workflow: bevry" /></a></span>
|
10 | <span class="badge-npmversion"><a href="https://npmjs.org/package/ignorefs" title="View this project on NPM"><img src="https://img.shields.io/npm/v/ignorefs.svg" alt="NPM version" /></a></span>
|
11 | <span class="badge-npmdownloads"><a href="https://npmjs.org/package/ignorefs" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/ignorefs.svg" alt="NPM downloads" /></a></span>
|
12 | <br class="badge-separator" />
|
13 | <span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span>
|
14 | <span class="badge-thanksdev"><a href="https://thanks.dev/u/gh/bevry" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a></span>
|
15 | <span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
|
16 | <span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
|
17 | <span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span>
|
18 | <span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
|
19 | <span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span>
|
20 | <span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
|
21 | <br class="badge-separator" />
|
22 | <span class="badge-discord"><a href="https://discord.gg/nQuXddV7VP" title="Join this project's community on Discord"><img src="https://img.shields.io/discord/1147436445783560193?logo=discord&label=discord" alt="Discord server badge" /></a></span>
|
23 | <span class="badge-twitch"><a href="https://www.twitch.tv/balupton" title="Join this project's community on Twitch"><img src="https://img.shields.io/twitch/status/balupton?logo=twitch" alt="Twitch community badge" /></a></span>
|
24 |
|
25 |
|
26 |
|
27 |
|
28 |
|
29 | Ignore common and custom patterns of the file system
|
30 |
|
31 |
|
32 |
|
33 |
|
34 | ## Usage
|
35 |
|
36 | [Complete API Documentation.](http://master.ignorefs.bevry.surge.sh/docs/)
|
37 |
|
38 |
|
39 |
|
40 | ## Install
|
41 |
|
42 | ### [npm](https://npmjs.com "npm is a package manager for javascript")
|
43 |
|
44 | - Install: `npm install --save ignorefs`
|
45 | - Import: `import pkg from ('ignorefs')`
|
46 | - Require: `const pkg = require('ignorefs').default`
|
47 |
|
48 | ### [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative for Node.js")
|
49 |
|
50 | ``` typescript
|
51 | import pkg from 'https://unpkg.com/ignorefs@^5.0.4/edition-deno/index.ts'
|
52 | ```
|
53 | ### [Editions](https://editions.bevry.me "Editions are the best way to produce and consume packages you care about.")
|
54 |
|
55 | This package is published with the following editions:
|
56 | - `ignorefs` aliases `ignorefs/index.cjs` which uses the [Editions Autoloader](https://github.com/bevry/editions "You can use the Editions Autoloader to autoload the appropriate edition for your consumers environment") to automatically select the correct edition for the consumer's environment
|
57 | - `ignorefs/source/index.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") source code with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
|
58 | - `ignorefs/edition-es2022/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2022](https://en.wikipedia.org/wiki/ES2022 "ECMAScript 2022") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules
|
59 | - `ignorefs/edition-es2017/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2017](https://en.wikipedia.org/wiki/ES2017 "ECMAScript 2017") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules
|
60 | - `ignorefs/edition-es5/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against ES5 for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules
|
61 | - `ignorefs/edition-es2017-esm/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2017](https://en.wikipedia.org/wiki/ES2017 "ECMAScript 2017") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 12 || 14 || 16 || 18 || 20 || 21 with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
|
62 | - `ignorefs/edition-types/index.d.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled Types with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
|
63 | - `ignorefs/edition-deno/index.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") source code made to be compatible with [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative to Node.js")
|
64 |
|
65 |
|
66 |
|
67 |
|
68 |
|
69 | ## History
|
70 |
|
71 | [Discover the release history by heading on over to the `HISTORY.md` file.](https://github.com/bevry/ignorefs/blob/HEAD/HISTORY.md#files)
|
72 |
|
73 |
|
74 |
|
75 |
|
76 |
|
77 | ## Backers
|
78 |
|
79 | ### Code
|
80 |
|
81 | [Discover how to contribute via the `CONTRIBUTING.md` file.](https://github.com/bevry/ignorefs/blob/HEAD/CONTRIBUTING.md#files)
|
82 |
|
83 | #### Authors
|
84 |
|
85 | - [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.
|
86 |
|
87 | #### Maintainers
|
88 |
|
89 | - [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.
|
90 |
|
91 | #### Contributors
|
92 |
|
93 | - [Benjamin Lupton](https://github.com/balupton) — [view contributions](https://github.com/bevry/ignorefs/commits?author=balupton "View the GitHub contributions of Benjamin Lupton on repository bevry/ignorefs")
|
94 |
|
95 | ### Finances
|
96 |
|
97 | <span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span>
|
98 | <span class="badge-thanksdev"><a href="https://thanks.dev/u/gh/bevry" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a></span>
|
99 | <span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
|
100 | <span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
|
101 | <span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span>
|
102 | <span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
|
103 | <span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span>
|
104 | <span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
|
105 |
|
106 | #### Sponsors
|
107 |
|
108 | - [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher
|
109 | - [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders.
|
110 | - [Codecov](https://codecov.io) — Empower developers with tools to improve code quality and testing.
|
111 | - [Poonacha Medappa](https://poonachamedappa.com)
|
112 | - [Rob Morris](https://github.com/Rob-Morris)
|
113 | - [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games.
|
114 | - [Syntax](https://syntax.fm) — Syntax Podcast
|
115 |
|
116 | #### Donors
|
117 |
|
118 | - [Andrew Nesbitt](https://nesbitt.io)
|
119 | - [Armen Mkrtchian](https://mogoni.dev)
|
120 | - [Balsa](https://balsa.com)
|
121 | - [Chad](https://opencollective.com/chad8)
|
122 | - [Codecov](https://codecov.io)
|
123 | - [dr.dimitru](https://veliovgroup.com)
|
124 | - [Elliott Ditman](https://elliottditman.com)
|
125 | - [entroniq](https://gitlab.com/entroniq)
|
126 | - [GitHub](https://github.com/about)
|
127 | - [Hunter Beast](https://cryptoquick.com)
|
128 | - [Jean-Luc Geering](https://github.com/jlgeering)
|
129 | - [Michael Duane Mooring](https://mdm.cc)
|
130 | - [Michael Harry Scepaniak](https://michaelscepaniak.com)
|
131 | - [Mohammed Shah](https://github.com/smashah)
|
132 | - [Mr. Henry](https://mrhenry.be)
|
133 | - [Nermal](https://arjunaditya.vercel.app)
|
134 | - [Pleo](https://pleo.io)
|
135 | - [Poonacha Medappa](https://poonachamedappa.com)
|
136 | - [Rob Morris](https://github.com/Rob-Morris)
|
137 | - [Robert de Forest](https://github.com/rdeforest)
|
138 | - [Sentry](https://sentry.io)
|
139 | - [ServieJS](https://github.com/serviejs)
|
140 | - [Skunk Team](https://skunk.team)
|
141 | - [Syntax](https://syntax.fm)
|
142 | - [WriterJohnBuck](https://github.com/WriterJohnBuck)
|
143 |
|
144 |
|
145 |
|
146 |
|
147 |
|
148 | ## License
|
149 |
|
150 | Unless stated otherwise all works are:
|
151 |
|
152 | - Copyright © [Benjamin Lupton](https://balupton.com)
|
153 |
|
154 | and licensed under:
|
155 |
|
156 | - [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)
|
157 |
|
158 |
|