immosquare-cleaner 0.1.38 → 0.1.39

Sign up to get free protection for your applications and to get access to all the features.
Files changed (79) hide show
  1. checksums.yaml +4 -4
  2. data/lib/immosquare-cleaner/version.rb +1 -1
  3. data/node_modules/@eslint/config-array/LICENSE +201 -0
  4. data/node_modules/@eslint/config-array/README.md +340 -0
  5. data/node_modules/@eslint/config-array/dist/cjs/index.cjs +1260 -0
  6. data/node_modules/@eslint/config-array/dist/cjs/index.d.cts +146 -0
  7. data/node_modules/@eslint/config-array/dist/cjs/types.ts +24 -0
  8. data/node_modules/@eslint/config-array/dist/esm/index.d.ts +146 -0
  9. data/node_modules/@eslint/config-array/dist/esm/index.js +1258 -0
  10. data/node_modules/@eslint/config-array/dist/esm/types.d.ts +19 -0
  11. data/node_modules/@eslint/config-array/dist/esm/types.ts +24 -0
  12. data/node_modules/@eslint/config-array/node_modules/minimatch/LICENSE +15 -0
  13. data/node_modules/@eslint/config-array/node_modules/minimatch/README.md +230 -0
  14. data/node_modules/@eslint/config-array/node_modules/minimatch/minimatch.js +947 -0
  15. data/node_modules/@eslint/config-array/node_modules/minimatch/node_modules/brace-expansion/LICENSE +21 -0
  16. data/node_modules/@eslint/config-array/node_modules/minimatch/node_modules/brace-expansion/README.md +129 -0
  17. data/node_modules/@eslint/config-array/node_modules/minimatch/node_modules/brace-expansion/index.js +201 -0
  18. data/node_modules/@eslint/config-array/node_modules/minimatch/node_modules/brace-expansion/package.json +47 -0
  19. data/node_modules/@eslint/config-array/node_modules/minimatch/package.json +33 -0
  20. data/node_modules/@eslint/config-array/package.json +60 -0
  21. data/node_modules/@eslint/js/package.json +1 -1
  22. data/node_modules/@eslint/object-schema/LICENSE +201 -0
  23. data/node_modules/@eslint/object-schema/README.md +224 -0
  24. data/node_modules/@eslint/object-schema/dist/cjs/index.cjs +455 -0
  25. data/node_modules/@eslint/object-schema/dist/cjs/index.d.cts +123 -0
  26. data/node_modules/@eslint/object-schema/dist/cjs/types.ts +55 -0
  27. data/node_modules/@eslint/object-schema/dist/esm/index.d.ts +123 -0
  28. data/node_modules/@eslint/object-schema/dist/esm/index.js +452 -0
  29. data/node_modules/@eslint/object-schema/dist/esm/types.d.ts +40 -0
  30. data/node_modules/@eslint/object-schema/dist/esm/types.ts +55 -0
  31. data/node_modules/@eslint/object-schema/package.json +56 -0
  32. data/node_modules/eslint/lib/cli.js +2 -2
  33. data/node_modules/eslint/lib/config/flat-config-array.js +1 -1
  34. data/node_modules/eslint/lib/eslint/eslint-helpers.js +7 -7
  35. data/node_modules/eslint/lib/eslint/eslint.js +1 -10
  36. data/node_modules/eslint/lib/rule-tester/rule-tester.js +1 -1
  37. data/node_modules/eslint/lib/rules/func-style.js +4 -4
  38. data/node_modules/eslint/lib/rules/no-constructor-return.js +1 -1
  39. data/node_modules/eslint/lib/rules/no-loop-func.js +161 -129
  40. data/node_modules/eslint/package.json +3 -3
  41. data/node_modules/prettier/LICENSE +56 -535
  42. data/node_modules/prettier/bin/prettier.cjs +4 -8
  43. data/node_modules/prettier/doc.js +20 -29
  44. data/node_modules/prettier/doc.mjs +20 -29
  45. data/node_modules/prettier/index.cjs +1 -1
  46. data/node_modules/prettier/index.d.ts +4 -2
  47. data/node_modules/prettier/index.mjs +3109 -4509
  48. data/node_modules/prettier/internal/cli.mjs +339 -3544
  49. data/node_modules/prettier/package.json +1 -1
  50. data/node_modules/prettier/plugins/acorn.js +11 -11
  51. data/node_modules/prettier/plugins/acorn.mjs +11 -11
  52. data/node_modules/prettier/plugins/angular.js +1 -1
  53. data/node_modules/prettier/plugins/angular.mjs +1 -1
  54. data/node_modules/prettier/plugins/babel.js +11 -11
  55. data/node_modules/prettier/plugins/babel.mjs +11 -11
  56. data/node_modules/prettier/plugins/estree.js +28 -28
  57. data/node_modules/prettier/plugins/estree.mjs +28 -28
  58. data/node_modules/prettier/plugins/flow.js +16 -17
  59. data/node_modules/prettier/plugins/flow.mjs +16 -17
  60. data/node_modules/prettier/plugins/glimmer.js +22 -22
  61. data/node_modules/prettier/plugins/glimmer.mjs +22 -22
  62. data/node_modules/prettier/plugins/graphql.js +4 -4
  63. data/node_modules/prettier/plugins/graphql.mjs +4 -4
  64. data/node_modules/prettier/plugins/html.js +15 -15
  65. data/node_modules/prettier/plugins/html.mjs +15 -15
  66. data/node_modules/prettier/plugins/markdown.js +42 -42
  67. data/node_modules/prettier/plugins/markdown.mjs +42 -42
  68. data/node_modules/prettier/plugins/meriyah.js +5 -5
  69. data/node_modules/prettier/plugins/meriyah.mjs +5 -5
  70. data/node_modules/prettier/plugins/postcss.js +26 -26
  71. data/node_modules/prettier/plugins/postcss.mjs +26 -26
  72. data/node_modules/prettier/plugins/typescript.js +20 -20
  73. data/node_modules/prettier/plugins/typescript.mjs +20 -20
  74. data/node_modules/prettier/plugins/yaml.js +32 -32
  75. data/node_modules/prettier/plugins/yaml.mjs +32 -32
  76. data/node_modules/prettier/standalone.js +26 -26
  77. data/node_modules/prettier/standalone.mjs +26 -26
  78. data/package.json +3 -3
  79. metadata +30 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 826f3aa2e653950168ccbbb34157ad1096e6a9e70f2c017e5bd3081ab7757114
4
- data.tar.gz: b2363325006e03329f63de37f1c62801f8bc57ca4570511fb367e4dfd80869ac
3
+ metadata.gz: 662eeb40e52c560a97f249cb9a4e5b3d1d80285e8391c60f719028e2cc3d89ce
4
+ data.tar.gz: ef9f7f751deaa0921133beed9c05bcd0c641efa68cef3fe6f6a1fe760201e21e
5
5
  SHA512:
6
- metadata.gz: 1a0f7f2846f19cac93d25f63d29527e6eb9297fda94e1a0058e45abbee950c447f97f354ad79f5ba85da58aac0e8f2afaa5003c1c45f21bbea38e4aca58b3b59
7
- data.tar.gz: '09aed90bad520d075dd1b951f5654df5c97f053776d8f7b3dc62668eac92fbb190061d1b6313b629320bb85cd9b2b24c50a97071a7ca24a16c271b1f91275697'
6
+ metadata.gz: 943bde00627ece2cf5df78f727473c73fa501d21adf0fa433c3a8f59d62625530f4dbeab2e4d5ff27be15bad2cc52d6b578a158d7ccc63b7a4b0657019c4263d
7
+ data.tar.gz: fdb856a0c4deb5f4aabef0182f9fb1944cdfbd6526aa16650369d8bf61e519775200d1d227bfd08fe104a11ec7cda5135296bc1377d83f116c9e600499a219d7
@@ -1,3 +1,3 @@
1
1
  module ImmosquareCleaner
2
- VERSION = "0.1.38".freeze
2
+ VERSION = "0.1.39".freeze
3
3
  end
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,340 @@
1
+ # Config Array
2
+
3
+ ## Description
4
+
5
+ A config array is a way of managing configurations that are based on glob pattern matching of filenames. Each config array contains the information needed to determine the correct configuration for any file based on the filename.
6
+
7
+ **Note:** This is a generic package that can be used outside of ESLint. It contains no ESLint-specific functionality.
8
+
9
+ ## Installation
10
+
11
+ For Node.js and compatible runtimes:
12
+
13
+ ```shell
14
+ npm install @eslint/config-array
15
+ # or
16
+ yarn add @eslint/config-array
17
+ # or
18
+ pnpm install @eslint/config-array
19
+ # or
20
+ bun install @eslint/config-array
21
+ ```
22
+
23
+ For Deno:
24
+
25
+ ```shell
26
+ deno add @eslint/config-array
27
+ ```
28
+
29
+ ## Background
30
+
31
+ The basic idea is that all configuration, including overrides, can be represented by a single array where each item in the array is a config object. Config objects appearing later in the array override config objects appearing earlier in the array. You can calculate a config for a given file by traversing all config objects in the array to find the ones that match the filename. Matching is done by specifying glob patterns in `files` and `ignores` properties on each config object. Here's an example:
32
+
33
+ ```js
34
+ export default [
35
+ // match all JSON files
36
+ {
37
+ name: "JSON Handler",
38
+ files: ["**/*.json"],
39
+ handler: jsonHandler,
40
+ },
41
+
42
+ // match only package.json
43
+ {
44
+ name: "package.json Handler",
45
+ files: ["package.json"],
46
+ handler: packageJsonHandler,
47
+ },
48
+ ];
49
+ ```
50
+
51
+ In this example, there are two config objects: the first matches all JSON files in all directories and the second matches just `package.json` in the base path directory (all the globs are evaluated as relative to a base path that can be specified). When you retrieve a configuration for `foo.json`, only the first config object matches so `handler` is equal to `jsonHandler`; when you retrieve a configuration for `package.json`, `handler` is equal to `packageJsonHandler` (because both config objects match, the second one wins).
52
+
53
+ ## Usage
54
+
55
+ First, import the `ConfigArray` constructor:
56
+
57
+ ```js
58
+ import { ConfigArray } from "@eslint/config-array";
59
+
60
+ // or using CommonJS
61
+
62
+ const { ConfigArray } = require("@eslint/config-array");
63
+ ```
64
+
65
+ When you create a new instance of `ConfigArray`, you must pass in two arguments: an array of configs and an options object. The array of configs is most likely read in from a configuration file, so here's a typical example:
66
+
67
+ ```js
68
+ const configFilename = path.resolve(process.cwd(), "my.config.js");
69
+ const { default: rawConfigs } = await import(configFilename);
70
+ const configs = new ConfigArray(rawConfigs, {
71
+ // the path to match filenames from
72
+ basePath: process.cwd(),
73
+
74
+ // additional items in each config
75
+ schema: mySchema,
76
+ });
77
+ ```
78
+
79
+ This example reads in an object or array from `my.config.js` and passes it into the `ConfigArray` constructor as the first argument. The second argument is an object specifying the `basePath` (the directory in which `my.config.js` is found) and a `schema` to define the additional properties of a config object beyond `files`, `ignores`, and `name`.
80
+
81
+ ### Specifying a Schema
82
+
83
+ The `schema` option is required for you to use additional properties in config objects. The schema is an object that follows the format of an [`ObjectSchema`](https://npmjs.com/package/@eslint/object-schema). The schema specifies both validation and merge rules that the `ConfigArray` instance needs to combine configs when there are multiple matches. Here's an example:
84
+
85
+ ```js
86
+ const configFilename = path.resolve(process.cwd(), "my.config.js");
87
+ const { default: rawConfigs } = await import(configFilename);
88
+
89
+ const mySchema = {
90
+
91
+ // define the handler key in configs
92
+ handler: {
93
+ required: true,
94
+ merge(a, b) {
95
+ if (!b) return a;
96
+ if (!a) return b;
97
+ },
98
+ validate(value) {
99
+ if (typeof value !== "function") {
100
+ throw new TypeError("Function expected.");
101
+ }
102
+ }
103
+ }
104
+ };
105
+
106
+ const configs = new ConfigArray(rawConfigs, {
107
+
108
+ // the path to match filenames from
109
+ basePath: process.cwd(),
110
+
111
+ // additional item schemas in each config
112
+ schema: mySchema,
113
+
114
+ // additional config types supported (default: [])
115
+ extraConfigTypes: ["array", "function"];
116
+ });
117
+ ```
118
+
119
+ ### Config Arrays
120
+
121
+ Config arrays can be multidimensional, so it's possible for a config array to contain another config array when `extraConfigTypes` contains `"array"`, such as:
122
+
123
+ ```js
124
+ export default [
125
+ // JS config
126
+ {
127
+ files: ["**/*.js"],
128
+ handler: jsHandler,
129
+ },
130
+
131
+ // JSON configs
132
+ [
133
+ // match all JSON files
134
+ {
135
+ name: "JSON Handler",
136
+ files: ["**/*.json"],
137
+ handler: jsonHandler,
138
+ },
139
+
140
+ // match only package.json
141
+ {
142
+ name: "package.json Handler",
143
+ files: ["package.json"],
144
+ handler: packageJsonHandler,
145
+ },
146
+ ],
147
+
148
+ // filename must match function
149
+ {
150
+ files: [filePath => filePath.endsWith(".md")],
151
+ handler: markdownHandler,
152
+ },
153
+
154
+ // filename must match all patterns in subarray
155
+ {
156
+ files: [["*.test.*", "*.js"]],
157
+ handler: jsTestHandler,
158
+ },
159
+
160
+ // filename must not match patterns beginning with !
161
+ {
162
+ name: "Non-JS files",
163
+ files: ["!*.js"],
164
+ settings: {
165
+ js: false,
166
+ },
167
+ },
168
+ ];
169
+ ```
170
+
171
+ In this example, the array contains both config objects and a config array. When a config array is normalized (see details below), it is flattened so only config objects remain. However, the order of evaluation remains the same.
172
+
173
+ If the `files` array contains a function, then that function is called with the absolute path of the file and is expected to return `true` if there is a match and `false` if not. (The `ignores` array can also contain functions.)
174
+
175
+ If the `files` array contains an item that is an array of strings and functions, then all patterns must match in order for the config to match. In the preceding examples, both `*.test.*` and `*.js` must match in order for the config object to be used.
176
+
177
+ If a pattern in the files array begins with `!` then it excludes that pattern. In the preceding example, any filename that doesn't end with `.js` will automatically get a `settings.js` property set to `false`.
178
+
179
+ You can also specify an `ignores` key that will force files matching those patterns to not be included. If the `ignores` key is in a config object without any other keys, then those ignores will always be applied; otherwise those ignores act as exclusions. Here's an example:
180
+
181
+ ```js
182
+ export default [
183
+
184
+ // Always ignored
185
+ {
186
+ ignores: ["**/.git/**", "**/node_modules/**"]
187
+ },
188
+
189
+ // .eslintrc.js file is ignored only when .js file matches
190
+ {
191
+ files: ["**/*.js"],
192
+ ignores: [".eslintrc.js"]
193
+ handler: jsHandler
194
+ }
195
+ ];
196
+ ```
197
+
198
+ You can use negated patterns in `ignores` to exclude a file that was already ignored, such as:
199
+
200
+ ```js
201
+ export default [
202
+ // Ignore all JSON files except tsconfig.json
203
+ {
204
+ files: ["**/*"],
205
+ ignores: ["**/*.json", "!tsconfig.json"],
206
+ },
207
+ ];
208
+ ```
209
+
210
+ ### Config Functions
211
+
212
+ Config arrays can also include config functions when `extraConfigTypes` contains `"function"`. A config function accepts a single parameter, `context` (defined by you), and must return either a config object or a config array (it cannot return another function). Config functions allow end users to execute code in the creation of appropriate config objects. Here's an example:
213
+
214
+ ```js
215
+ export default [
216
+ // JS config
217
+ {
218
+ files: ["**/*.js"],
219
+ handler: jsHandler,
220
+ },
221
+
222
+ // JSON configs
223
+ function (context) {
224
+ return [
225
+ // match all JSON files
226
+ {
227
+ name: context.name + " JSON Handler",
228
+ files: ["**/*.json"],
229
+ handler: jsonHandler,
230
+ },
231
+
232
+ // match only package.json
233
+ {
234
+ name: context.name + " package.json Handler",
235
+ files: ["package.json"],
236
+ handler: packageJsonHandler,
237
+ },
238
+ ];
239
+ },
240
+ ];
241
+ ```
242
+
243
+ When a config array is normalized, each function is executed and replaced in the config array with the return value.
244
+
245
+ **Note:** Config functions can also be async.
246
+
247
+ ### Normalizing Config Arrays
248
+
249
+ Once a config array has been created and loaded with all of the raw config data, it must be normalized before it can be used. The normalization process goes through and flattens the config array as well as executing all config functions to get their final values.
250
+
251
+ To normalize a config array, call the `normalize()` method and pass in a context object:
252
+
253
+ ```js
254
+ await configs.normalize({
255
+ name: "MyApp",
256
+ });
257
+ ```
258
+
259
+ The `normalize()` method returns a promise, so be sure to use the `await` operator. The config array instance is normalized in-place, so you don't need to create a new variable.
260
+
261
+ If you want to disallow async config functions, you can call `normalizeSync()` instead. This method is completely synchronous and does not require using the `await` operator as it does not return a promise:
262
+
263
+ ```js
264
+ await configs.normalizeSync({
265
+ name: "MyApp",
266
+ });
267
+ ```
268
+
269
+ **Important:** Once a `ConfigArray` is normalized, it cannot be changed further. You can, however, create a new `ConfigArray` and pass in the normalized instance to create an unnormalized copy.
270
+
271
+ ### Getting Config for a File
272
+
273
+ To get the config for a file, use the `getConfig()` method on a normalized config array and pass in the filename to get a config for:
274
+
275
+ ```js
276
+ // pass in absolute filename
277
+ const fileConfig = configs.getConfig(
278
+ path.resolve(process.cwd(), "package.json"),
279
+ );
280
+ ```
281
+
282
+ The config array always returns an object, even if there are no configs matching the given filename. You can then inspect the returned config object to determine how to proceed.
283
+
284
+ A few things to keep in mind:
285
+
286
+ - You must pass in the absolute filename to get a config for.
287
+ - The returned config object never has `files`, `ignores`, or `name` properties; the only properties on the object will be the other configuration options specified.
288
+ - The config array caches configs, so subsequent calls to `getConfig()` with the same filename will return in a fast lookup rather than another calculation.
289
+ - A config will only be generated if the filename matches an entry in a `files` key. A config will not be generated without matching a `files` key (configs without a `files` key are only applied when another config with a `files` key is applied; configs without `files` are never applied on their own). Any config with a `files` key entry ending with `/**` or `/*` will only be applied if another entry in the same `files` key matches or another config matches.
290
+
291
+ ## Determining Ignored Paths
292
+
293
+ You can determine if a file is ignored by using the `isFileIgnored()` method and passing in the absolute path of any file, as in this example:
294
+
295
+ ```js
296
+ const ignored = configs.isFileIgnored("/foo/bar/baz.txt");
297
+ ```
298
+
299
+ A file is considered ignored if any of the following is true:
300
+
301
+ - **It's parent directory is ignored.** For example, if `foo` is in `ignores`, then `foo/a.js` is considered ignored.
302
+ - **It has an ancestor directory that is ignored.** For example, if `foo` is in `ignores`, then `foo/baz/a.js` is considered ignored.
303
+ - **It matches an ignored file pattern.** For example, if `**/a.js` is in `ignores`, then `foo/a.js` and `foo/baz/a.js` are considered ignored.
304
+ - **If it matches an entry in `files` and also in `ignores`.** For example, if `**/*.js` is in `files` and `**/a.js` is in `ignores`, then `foo/a.js` and `foo/baz/a.js` are considered ignored.
305
+ - **The file is outside the `basePath`.** If the `basePath` is `/usr/me`, then `/foo/a.js` is considered ignored.
306
+
307
+ For directories, use the `isDirectoryIgnored()` method and pass in the absolute path of any directory, as in this example:
308
+
309
+ ```js
310
+ const ignored = configs.isDirectoryIgnored("/foo/bar/");
311
+ ```
312
+
313
+ A directory is considered ignored if any of the following is true:
314
+
315
+ - **It's parent directory is ignored.** For example, if `foo` is in `ignores`, then `foo/baz` is considered ignored.
316
+ - **It has an ancestor directory that is ignored.** For example, if `foo` is in `ignores`, then `foo/bar/baz/a.js` is considered ignored.
317
+ - **It matches and ignored file pattern.** For example, if `**/a.js` is in `ignores`, then `foo/a.js` and `foo/baz/a.js` are considered ignored.
318
+ - **If it matches an entry in `files` and also in `ignores`.** For example, if `**/*.js` is in `files` and `**/a.js` is in `ignores`, then `foo/a.js` and `foo/baz/a.js` are considered ignored.
319
+ - **The file is outside the `basePath`.** If the `basePath` is `/usr/me`, then `/foo/a.js` is considered ignored.
320
+
321
+ **Important:** A pattern such as `foo/**` means that `foo` and `foo/` are _not_ ignored whereas `foo/bar` is ignored. If you want to ignore `foo` and all of its subdirectories, use the pattern `foo` or `foo/` in `ignores`.
322
+
323
+ ## Caching Mechanisms
324
+
325
+ Each `ConfigArray` aggressively caches configuration objects to avoid unnecessary work. This caching occurs in two ways:
326
+
327
+ 1. **File-based Caching.** For each filename that is passed into a method, the resulting config is cached against that filename so you're always guaranteed to get the same object returned from `getConfig()` whenever you pass the same filename in.
328
+ 2. **Index-based Caching.** Whenever a config is calculated, the config elements that were used to create the config are also cached. So if a given filename matches elements 1, 5, and 7, the resulting config is cached with a key of `1,5,7`. That way, if another file is passed that matches the same config elements, the result is already known and doesn't have to be recalculated. That means two files that match all the same elements will return the same config from `getConfig()`.
329
+
330
+ ## Acknowledgements
331
+
332
+ The design of this project was influenced by feedback on the ESLint RFC, and incorporates ideas from:
333
+
334
+ - Teddy Katz (@not-an-aardvark)
335
+ - Toru Nagashima (@mysticatea)
336
+ - Kai Cataldo (@kaicataldo)
337
+
338
+ ## License
339
+
340
+ Apache 2.0