editorconfig 1.0.3 → 2.0.0

package/README.md

@@ -35,6 +35,7 @@ Most of the API takes an `options` object, which has the following defaults:
   root: '/',
   files: undefined,
   cache: undefined,
+  unset: false,
 };
 ```
 
@@ -71,6 +72,11 @@ Most of the API takes an `options` object, which has the following defaults:
       fully-qualified file name of the config file and a `root: boolean` property
       that describes if the config file had a `root=true` at the top.  Any other
       properties in the objects should be treated as opaque.</dd>
+
+  <dt>unset</dt>
+  <dd>If true, after combining all properties, remove all properties whose value
+      remains as "unset".  This is typically left for plugin authors to do, and
+      the conformance tests assume that this value is always false.</dd>
 </dl>
 
 ### in Node.js:

package/lib/cli.js

@@ -65,6 +65,7 @@ async function cli(args, testing) {
         .option('-f <path>', 'Specify conf filename other than \'.editorconfig\'')
         .option('-b <version>', 'Specify version (used by devs to test compatibility)')
         .option('--files', 'Output file names that contributed to the configuration, rather than the configuation itself')
+        .option('--unset', 'Remove all properties whose final value is \'unset\'')
         .parse(args);
     const files = program.args;
     const opts = program.opts();
@@ -82,6 +83,7 @@ async function cli(args, testing) {
                 version: opts.b,
                 files: visited ? visited[i++] : undefined,
                 cache,
+                unset: Boolean(opts.unset),
             }));
         }
         return p;

package/lib/index.d.ts

@@ -39,6 +39,7 @@ export interface ParseOptions {
     root?: string;
     files?: Visited[];
     cache?: Cache;
+    unset?: boolean;
 }
 export type SectionName = string | null;
 export interface SectionBody {
@@ -84,6 +85,14 @@ export declare function parseFromFiles(filepath: string, files: Promise<ECFile[]
  * @deprecated
  */
 export declare function parseFromFilesSync(filepath: string, files: ECFile[], options?: ParseOptions): Props;
+/**
+ * For any pair, a value of `unset` removes the effect of that pair, even if
+ * it has been set before.  This method modifies the properties object in
+ * place to remove any property that has a value of `unset`.
+ *
+ * @param props Properties object to modify.
+ */
+export declare function unset(props: Props): void;
 /**
  * Find all of the properties from matching sections in config files in the
  * same directory or toward the root of the filesystem.
@@ -102,4 +111,18 @@ export declare function parse(filepath: string, options?: ParseOptions): Promise
  * @returns Combined properties for the target file
  */
 export declare function parseSync(filepath: string, options?: ParseOptions): Props;
+/**
+ * I think this may be of limited utility at the moment, but I need something
+ * like this for testing.  As such, the interface of this may change without
+ * warning.
+ *
+ * Something this direction may be better for editors than the caching bits
+ * we've got today, but that will need some thought.
+ *
+ * @param options All options.  root will be process.cwd if not specified.
+ * @param buffers 1 or more Buffers that have .editorconfig contents.
+ * @returns Function that can be called multiple times for different paths.
+ * @private
+ */
+export declare function matcher(options: ParseOptions, ...buffers: Buffer[]): (filepath: string) => Props;
 export {};

package/lib/index.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseSync = exports.parse = exports.parseFromFilesSync = exports.parseFromFiles = exports.parseString = exports.parseBuffer = void 0;
+exports.matcher = exports.parseSync = exports.parse = exports.unset = exports.parseFromFilesSync = exports.parseFromFiles = exports.parseString = exports.parseBuffer = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const semver = __importStar(require("semver"));
@@ -36,17 +36,16 @@ const wasm_1 = require("@one-ini/wasm");
 // package.json
 const package_json_1 = __importDefault(require("../package.json"));
 const escapedSep = new RegExp(path.sep.replace(/\\/g, '\\\\'), 'g');
-const matchOptions = { matchBase: true, dot: true, noext: true };
-// These are specified by the editorconfig script
-/* eslint-disable @typescript-eslint/naming-convention */
-const knownProps = {
-    end_of_line: true,
-    indent_style: true,
-    indent_size: true,
-    insert_final_newline: true,
-    trim_trailing_whitespace: true,
-    charset: true,
-};
+const matchOptions = { matchBase: true, dot: true };
+const knownPropNames = [
+    'end_of_line',
+    'indent_style',
+    'indent_size',
+    'insert_final_newline',
+    'trim_trailing_whitespace',
+    'charset',
+];
+const knownProps = new Set(knownPropNames);
 /**
  * Parse a buffer using the faster one-ini WASM approach into something
  * relatively easy to deal with in JS.
@@ -146,7 +145,7 @@ function processMatches(matches, version) {
 function buildFullGlob(pathPrefix, glob) {
     switch (glob.indexOf('/')) {
         case -1:
-            glob = '**/' + glob;
+            glob = `**/${glob}`;
             break;
         case 0:
             glob = glob.substring(1);
@@ -177,8 +176,7 @@ function normalizeProps(options) {
             const value = options[key];
             const key2 = key.toLowerCase();
             let value2 = value;
-            // @ts-ignore -- Fix types here
-            if (knownProps[key2]) {
+            if (knownProps.has(key2)) {
                 // All of the values for the known props are lowercase.
                 value2 = String(value).toLowerCase();
             }
@@ -191,7 +189,6 @@ function normalizeProps(options) {
                 // in editorconfig) & should just be returned as regular strings.
                 value2 = String(value);
             }
-            // @ts-ignore -- Fix types here
             props[key2] = value2;
         }
     }
@@ -357,6 +354,7 @@ function opts(filepath, options = {}) {
             root: path.resolve(options.root || path.parse(resolvedFilePath).root),
             files: options.files,
             cache: options.cache,
+            unset: options.unset,
         },
     ];
 }
@@ -426,8 +424,27 @@ function combine(filepath, configs, options) {
         }
         return props;
     }, {});
+    if (options.unset) {
+        unset(ret);
+    }
     return processMatches(ret, options.version);
 }
+/**
+ * For any pair, a value of `unset` removes the effect of that pair, even if
+ * it has been set before.  This method modifies the properties object in
+ * place to remove any property that has a value of `unset`.
+ *
+ * @param props Properties object to modify.
+ */
+function unset(props) {
+    const keys = Object.keys(props);
+    for (const k of keys) {
+        if (props[k] === 'unset') {
+            delete props[k];
+        }
+    }
+}
+exports.unset = unset;
 /**
  * Find all of the properties from matching sections in config files in the
  * same directory or toward the root of the filesystem.
@@ -458,3 +475,25 @@ function parseSync(filepath, options = {}) {
     return combine(resolvedFilePath, configs, processedOptions);
 }
 exports.parseSync = parseSync;
+/**
+ * I think this may be of limited utility at the moment, but I need something
+ * like this for testing.  As such, the interface of this may change without
+ * warning.
+ *
+ * Something this direction may be better for editors than the caching bits
+ * we've got today, but that will need some thought.
+ *
+ * @param options All options.  root will be process.cwd if not specified.
+ * @param buffers 1 or more Buffers that have .editorconfig contents.
+ * @returns Function that can be called multiple times for different paths.
+ * @private
+ */
+function matcher(options, ...buffers) {
+    const processedOptions = opts('', options)[1];
+    const configs = buffers.map((buf, i) => processFileContents(path.join(processedOptions.root, `buffer-${i}`), buf, processedOptions));
+    return (filepath) => {
+        const resolvedFilePath = path.resolve(filepath);
+        return combine(resolvedFilePath, configs, processedOptions);
+    };
+}
+exports.matcher = matcher;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "editorconfig",
-  "version": "1.0.3",
+  "version": "2.0.0",
   "description": "EditorConfig File Locator and Interpreter for Node.js",
   "keywords": [
     "editorconfig",
@@ -42,24 +42,35 @@
   "dependencies": {
     "@one-ini/wasm": "0.1.1",
     "commander": "^11.0.0",
-    "minimatch": "9.0.1",
+    "minimatch": "9.0.2",
     "semver": "^7.5.3"
   },
   "devDependencies": {
+    "@types/chai": "4.3.5",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^20.3.1",
+    "@types/node": "^20.3.3",
     "@types/semver": "^7.5.0",
-    "@typescript-eslint/eslint-plugin": "5.60.0",
-    "@typescript-eslint/parser": "5.60.0",
+    "@typescript-eslint/eslint-plugin": "5.60.1",
+    "@typescript-eslint/parser": "5.60.1",
     "c8": "8.0.0",
-    "eslint": "8.43.0",
-    "eslint-plugin-jsdoc": "46.2.6",
+    "chai": "4.3.7",
+    "eslint": "8.44.0",
+    "eslint-plugin-jsdoc": "46.4.3",
     "mocha": "^10.2.0",
     "rimraf": "^5.0.1",
-    "should": "^13.2.3",
-    "typescript": "^5.1.3"
+    "typescript": "^5.1.6"
+  },
+  "pnpm": {
+    "overrides": {
+      "semver": ">=7.5.3",
+      "word-wrap": "npm:@aashutoshrathi/word-wrap"
+    }
+  },
+  "overrides": {
+    "semver": "$semver",
+    "word-wrap": "npm:@aashutoshrathi/word-wrap"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   }
 }