editorconfig 1.0.4 → 2.0.1

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/eslint.config.mjs

@@ -0,0 +1,13 @@
+import base from '@cto.af/eslint-config';
+import ts from '@cto.af/eslint-config/ts.js';
+
+export default [
+  {
+    ignores: [
+      'lib/**',
+      '**/*.d.ts',
+    ],
+  },
+  ...base,
+  ...ts,
+];

package/lib/cli.d.ts

@@ -1,5 +1,5 @@
+import * as editorconfig from './index.js';
 import { type OutputConfiguration } from 'commander';
-import * as editorconfig from './';
 /**
  * Command line interface for editorconfig.  Pulled out into a separate module
  * to make it easier to test.

package/lib/cli.js

@@ -15,19 +15,30 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = cli;
+const editorconfig = __importStar(require("./index.js"));
 const commander_1 = require("commander");
-const editorconfig = __importStar(require("./"));
 const package_json_1 = __importDefault(require("../package.json"));
 /**
  * Default output routine, goes to stdout.
@@ -53,18 +64,18 @@ async function cli(args, testing) {
     let writeOut = writeStdOut;
     if (testing) {
         if (testing.writeOut) {
-            // eslint-disable-next-line @typescript-eslint/unbound-method
-            writeOut = testing.writeOut;
+            ({ writeOut } = testing);
         }
         program.configureOutput(testing);
         program.exitOverride();
     }
-    program.version('EditorConfig Node.js Core Version ' + package_json_1.default.version, '-v, --version', 'Display version information')
+    program.version(`EditorConfig Node.js Core Version ${package_json_1.default.version}`, '-v, --version', 'Display version information')
         .showHelpAfterError()
         .argument('<FILEPATH...>', 'Files to find configuration for.  Can be a hyphen (-) if you want path(s) to be read from stdin.')
         .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,11 +93,12 @@ async function cli(args, testing) {
                 version: opts.b,
                 files: visited ? visited[i++] : undefined,
                 cache,
+                unset: Boolean(opts.unset),
             }));
         }
         return p;
     }
-    return await processAll().then((parsed) => {
+    return processAll().then(parsed => {
         const header = parsed.length > 1;
         parsed.forEach((props, i) => {
             if (header) {
@@ -106,4 +118,3 @@ async function cli(args, testing) {
         return parsed;
     });
 }
-exports.default = cli;

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="node" />
+import { Buffer } from 'node:buffer';
 import { Minimatch } from 'minimatch';
 export interface KnownProps {
     end_of_line?: 'lf' | 'crlf' | 'unset';
@@ -39,6 +39,7 @@ export interface ParseOptions {
     root?: string;
     files?: Visited[];
     cache?: Cache;
+    unset?: boolean;
 }
 export type SectionName = string | null;
 export interface SectionBody {
@@ -62,28 +63,36 @@ export declare function parseBuffer(data: Buffer): ParseStringResult;
  * @deprecated Use {@link ParseBuffer} instead.
  */
 export declare function parseString(data: string): ParseStringResult;
+/**
+ * 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;
 /**
  * Low-level interface, which exists only for backward-compatibility.
  * Deprecated.
  *
  * @param filepath The name of the target file, relative to process.cwd().
- * @param files A promise for a list of objects describing the files.
+ * @param files A list of objects describing the files.
  * @param options All options
  * @returns The properties found for filepath
  * @deprecated
  */
-export declare function parseFromFiles(filepath: string, files: Promise<ECFile[]>, options?: ParseOptions): Promise<Props>;
+export declare function parseFromFilesSync(filepath: string, files: ECFile[], options?: ParseOptions): Props;
 /**
  * Low-level interface, which exists only for backward-compatibility.
  * Deprecated.
  *
  * @param filepath The name of the target file, relative to process.cwd().
- * @param files A list of objects describing the files.
+ * @param files A promise for a list of objects describing the files.
  * @param options All options
  * @returns The properties found for filepath
  * @deprecated
  */
-export declare function parseFromFilesSync(filepath: string, files: ECFile[], options?: ParseOptions): Props;
+export declare function parseFromFiles(filepath: string, files: Promise<ECFile[]>, options?: ParseOptions): Promise<Props>;
 /**
  * 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

@@ -15,38 +15,53 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 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;
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
+exports.parseBuffer = parseBuffer;
+exports.parseString = parseString;
+exports.unset = unset;
+exports.parseFromFilesSync = parseFromFilesSync;
+exports.parseFromFiles = parseFromFiles;
+exports.parse = parse;
+exports.parseSync = parseSync;
+exports.matcher = matcher;
+const fs = __importStar(require("node:fs"));
+const path = __importStar(require("node:path"));
 const semver = __importStar(require("semver"));
-const minimatch_1 = require("minimatch");
 const wasm_1 = require("@one-ini/wasm");
-// @ts-ignore So we can set the rootDir to be 'lib', without processing
-// package.json
+const node_buffer_1 = require("node:buffer");
+const minimatch_1 = require("minimatch");
 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.
@@ -82,7 +97,6 @@ function parseBuffer(data) {
     }
     return res;
 }
-exports.parseBuffer = parseBuffer;
 /**
  * Parses a string.  If possible, you should always use ParseBuffer instead,
  * since this function does a UTF16-to-UTF8 conversion first.
@@ -92,9 +106,8 @@ exports.parseBuffer = parseBuffer;
  * @deprecated Use {@link ParseBuffer} instead.
  */
 function parseString(data) {
-    return parseBuffer(Buffer.from(data));
+    return parseBuffer(node_buffer_1.Buffer.from(data));
 }
-exports.parseString = parseString;
 /**
  * Gets a list of *potential* filenames based on the path of the target
  * filename.
@@ -122,23 +135,23 @@ function getConfigFileNames(filepath, options) {
 function processMatches(matches, version) {
     // Set indent_size to 'tab' if indent_size is unspecified and
     // indent_style is set to 'tab'.
-    if ('indent_style' in matches
-        && matches.indent_style === 'tab'
-        && !('indent_size' in matches)
-        && semver.gte(version, '0.10.0')) {
+    if ('indent_style' in matches &&
+        matches.indent_style === 'tab' &&
+        !('indent_size' in matches) &&
+        semver.gte(version, '0.10.0')) {
         matches.indent_size = 'tab';
     }
     // Set tab_width to indent_size if indent_size is specified and
     // tab_width is unspecified
-    if ('indent_size' in matches
-        && !('tab_width' in matches)
-        && matches.indent_size !== 'tab') {
+    if ('indent_size' in matches &&
+        !('tab_width' in matches) &&
+        matches.indent_size !== 'tab') {
         matches.tab_width = matches.indent_size;
     }
     // Set indent_size to tab_width if indent_size is 'tab'
-    if ('indent_size' in matches
-        && 'tab_width' in matches
-        && matches.indent_size === 'tab') {
+    if ('indent_size' in matches &&
+        'tab_width' in matches &&
+        matches.indent_size === 'tab') {
         matches.indent_size = matches.tab_width;
     }
     return matches;
@@ -146,7 +159,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);
@@ -154,9 +167,11 @@ function buildFullGlob(pathPrefix, glob) {
         default:
             break;
     }
+    //
     // braces_escaped_backslash2
     // backslash_not_on_windows
     glob = glob.replace(/\\\\/g, '\\\\\\\\');
+    //
     // star_star_over_separator{1,3,5,6,9,15}
     glob = glob.replace(/\*\*/g, '{*,**/**/**}');
     // NOT path.join.  Must stay in forward slashes.
@@ -173,25 +188,26 @@ function buildFullGlob(pathPrefix, glob) {
 function normalizeProps(options) {
     const props = {};
     for (const key in options) {
-        if (options.hasOwnProperty(key)) {
+        if (Object.prototype.hasOwnProperty.call(options, key)) {
             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();
             }
             try {
                 value2 = JSON.parse(String(value));
             }
-            catch (e) { }
+            catch (_e) {
+                // Ignored
+            }
             if (typeof value2 === 'undefined' || value2 === null) {
+                //
                 // null and undefined are values specific to JSON (no special meaning
                 // in editorconfig) & should just be returned as regular strings.
                 value2 = String(value);
             }
-            // @ts-ignore -- Fix types here
             props[key2] = value2;
         }
     }
@@ -208,7 +224,8 @@ function normalizeProps(options) {
  * @returns Processed file with globs pre-computed.
  */
 function processFileContents(filepath, contents, options) {
-    let res;
+    let res = undefined;
+    // eslint-disable-next-line no-negated-condition
     if (!contents) {
         // Negative cache
         res = {
@@ -239,7 +256,7 @@ function processFileContents(filepath, contents, options) {
             name ? buildFullGlob(pathPrefix, name) : null,
         ]);
         res = {
-            root: !!globbed[0][1].root,
+            root: Boolean(globbed[0][1].root), // Global section: globbed[0]
             name: filepath,
             config: globbed,
         };
@@ -288,7 +305,7 @@ function getConfigSync(filepath, options) {
             return cached;
         }
     }
-    let contents;
+    let contents = undefined;
     try {
         contents = fs.readFileSync(filepath);
     }
@@ -357,23 +374,55 @@ function opts(filepath, options = {}) {
             root: path.resolve(options.root || path.parse(resolvedFilePath).root),
             files: options.files,
             cache: options.cache,
+            unset: options.unset,
         },
     ];
 }
 /**
- * Low-level interface, which exists only for backward-compatibility.
- * Deprecated.
+ * 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 filepath The name of the target file, relative to process.cwd().
- * @param files A promise for a list of objects describing the files.
- * @param options All options
- * @returns The properties found for filepath
- * @deprecated
+ * @param props Properties object to modify.
  */
-async function parseFromFiles(filepath, files, options = {}) {
-    return parseFromFilesSync(filepath, await files, options);
+function unset(props) {
+    const keys = Object.keys(props);
+    for (const k of keys) {
+        if (props[k] === 'unset') {
+            // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+            delete props[k];
+        }
+    }
+}
+/**
+ * Combine the pre-parsed results of all matching config file sections, in
+ * order.
+ *
+ * @param filepath The target file path
+ * @param configs All of the found config files, up to the root
+ * @param options Adds to `options.files` if it exists
+ * @returns Combined properties
+ */
+function combine(filepath, configs, options) {
+    const ret = configs.reverse().reduce((props, processed) => {
+        for (const [name, body, glob] of processed.config) {
+            if (glob === null || glob === void 0 ? void 0 : glob.match(filepath)) {
+                Object.assign(props, body);
+                if (options.files) {
+                    options.files.push({
+                        fileName: processed.name,
+                        glob: name,
+                    });
+                }
+            }
+        }
+        return props;
+    }, {});
+    if (options.unset) {
+        unset(ret);
+    }
+    return processMatches(ret, options.version);
 }
-exports.parseFromFiles = parseFromFiles;
 /**
  * Low-level interface, which exists only for backward-compatibility.
  * Deprecated.
@@ -388,7 +437,7 @@ function parseFromFilesSync(filepath, files, options = {}) {
     const [resolvedFilePath, processedOptions] = opts(filepath, options);
     const configs = [];
     for (const ecf of files) {
-        let cfg;
+        let cfg = undefined;
         if (!options.cache || !(cfg = options.cache.get(ecf.name))) { // Single "="!
             cfg = processFileContents(ecf.name, ecf.contents, processedOptions);
         }
@@ -401,32 +450,19 @@ function parseFromFilesSync(filepath, files, options = {}) {
     }
     return combine(resolvedFilePath, configs, processedOptions);
 }
-exports.parseFromFilesSync = parseFromFilesSync;
 /**
- * Combine the pre-parsed results of all matching config file sections, in
- * order.
+ * Low-level interface, which exists only for backward-compatibility.
+ * Deprecated.
  *
- * @param filepath The target file path
- * @param configs All of the found config files, up to the root
- * @param options Adds to `options.files` if it exists
- * @returns Combined properties
+ * @param filepath The name of the target file, relative to process.cwd().
+ * @param files A promise for a list of objects describing the files.
+ * @param options All options
+ * @returns The properties found for filepath
+ * @deprecated
  */
-function combine(filepath, configs, options) {
-    const ret = configs.reverse().reduce((props, processed) => {
-        for (const [name, body, glob] of processed.config) {
-            if (glob && glob.match(filepath)) {
-                Object.assign(props, body);
-                if (options.files) {
-                    options.files.push({
-                        fileName: processed.name,
-                        glob: name,
-                    });
-                }
-            }
-        }
-        return props;
-    }, {});
-    return processMatches(ret, options.version);
+async function parseFromFiles(filepath, files, options = {}) {
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    return parseFromFilesSync(filepath, await files, options);
 }
 /**
  * Find all of the properties from matching sections in config files in the
@@ -442,7 +478,6 @@ async function parse(filepath, options = {}) {
     const configs = await getAllConfigs(filepaths, processedOptions);
     return combine(resolvedFilePath, configs, processedOptions);
 }
-exports.parse = parse;
 /**
  * Find all of the properties from matching sections in config files in the
  * same directory or toward the root of the filesystem.  Synchronous.
@@ -457,4 +492,24 @@ function parseSync(filepath, options = {}) {
     const configs = getAllConfigsSync(filepaths, processedOptions);
     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 [_fileName, processedOptions] = opts('', options);
+    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);
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "editorconfig",
-  "version": "1.0.4",
+  "version": "2.0.1",
   "description": "EditorConfig File Locator and Interpreter for Node.js",
   "keywords": [
     "editorconfig",
@@ -17,21 +17,6 @@
     "bin": "./bin",
     "lib": "./lib"
   },
-  "scripts": {
-    "clean": "rimraf lib cmake_install.cmake CTestTestfile.cmake Makefile",
-    "prebuild": "npm run clean",
-    "build": "cmake . && tsc",
-    "pretest": "npm run build && npm run lint",
-    "test": "npm run test:all",
-    "test:all": "mocha && ctest . --preset Test",
-    "precoverage": "npm run build -- --inlineSourceMap",
-    "coverage": "c8 npm run test:all",
-    "postcoverage": "npm run build",
-    "ci": "npm run coverage -- -- -VV --output-on-failure",
-    "lint": "eslint . --ext ts",
-    "prepub": "npm run lint && npm run build",
-    "pub": "npm publish"
-  },
   "repository": {
     "type": "git",
     "url": "git://github.com/editorconfig/editorconfig-core-js.git"
@@ -40,26 +25,12 @@
   "author": "EditorConfig Team",
   "license": "MIT",
   "dependencies": {
-    "@one-ini/wasm": "0.1.1",
-    "commander": "^10.0.0",
-    "minimatch": "9.0.1",
-    "semver": "^7.5.3"
-  },
-  "devDependencies": {
-    "@types/mocha": "^10.0.1",
-    "@types/node": "^20.3.1",
-    "@types/semver": "^7.5.0",
-    "@typescript-eslint/eslint-plugin": "5.60.0",
-    "@typescript-eslint/parser": "5.60.0",
-    "c8": "8.0.0",
-    "eslint": "8.43.0",
-    "eslint-plugin-jsdoc": "46.2.6",
-    "mocha": "^10.2.0",
-    "rimraf": "^5.0.1",
-    "should": "^13.2.3",
-    "typescript": "^5.1.3"
+    "@one-ini/wasm": "0.2.0",
+    "commander": "^13.1.0",
+    "minimatch": "10.0.1",
+    "semver": "^7.7.1"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=18"
   }
 }