fix: do not include Configstore if not necessary (#270)

* fix: do not include Configstore if not necessary

* ci: make sure line endings are preserved

.gitattributes

@@ -1,2 +1,5 @@
 # Set the default behavior, in case people don't have core.autocrlf set.
 * text=auto
+*.txt       text eol=lf
+*.ts        text eol=lf
+*.js        text eol=lf

generator-cspell-dicts/generators/app/templates/package.json

@@ -7,6 +7,10 @@
     "<%= fullPackageName %>-link": "./link.js",
     "<%= fullPackageName %>-unlink": "./unlink.js"
   },
+  "exports": {
+    ".": "./index.js",
+    "./cspell-ext.json": "./cspell-ext.json"
+  },
   "scripts": {
     "build": "cross-env NODE_OPTIONS=--max_old_space_size=8192 cspell-tools <%= command %> \"<%= srcFile %>\" -o .",
     "test": "head -n 100 \"<%= srcFile %>\" | cspell -v -c ./cspell-ext.json \"--local=<%= local %>\" \"--languageId=<%= languageId %>\" stdin",
@@ -34,8 +38,7 @@
     "url": "https://github.com/streetsidesoftware/cspell-dicts/issues"
   },
   "homepage": "https://github.com/streetsidesoftware/cspell-dicts/blob/master/packages/<%= name %>#readme",
-  "devDependencies": {
-  },
+  "devDependencies": {},
   "dependencies": {
     "configstore": "^5.0.0"
   },

packages/ada/index.js

@@ -1,9 +1,9 @@
 'use strict';
 
-var util = require('./util');
+const configLocation = require.resolve('./cspell-ext.json');
 
 function getConfigLocation() {
-    return util.configLocation;
+    return configLocation;
 }
 
 module.exports = {

packages/ada/link.js

@@ -2,6 +2,6 @@
 
 'use strict';
 
-var util = require('./util');
+const util = require('./util');
 
 util.install();

packages/ada/package.json

@@ -6,6 +6,10 @@
     "cspell-dict-ada-link": "./link.js",
     "cspell-dict-ada-unlink": "./unlink.js"
   },
+  "exports": {
+    ".": "./index.js",
+    "./cspell-ext.json": "./cspell-ext.json"
+  },
   "scripts": {
     "build": "cspell-tools compile \"ada.txt\" -o .",
     "test": "head -n 100 \"ada.txt\" | cspell -v -c ./cspell-ext.json --local=* --languageId=ada stdin",

packages/ada/unlink.js

@@ -2,6 +2,6 @@
 
 'use strict';
 
-var util = require('./util');
+const util = require('./util');
 
 util.uninstall();

packages/ada/util.js

@@ -1,42 +1,40 @@
 'use strict';
 
 // Cspell:word configstore
-var Configstore = require('configstore');
-var Path = require('path');
+const Configstore = require('configstore');
 
-var packageName = 'cspell';
-var importPath = 'import';
-var configLocation = Path.join(__dirname, 'cspell-ext.json');
+const packageName = 'cspell';
+const importPath = 'import';
+const configLocation = require.resolve('./cspell-ext.json');
 
+/**
+ *
+ * @param {Configstore} conf
+ * @returns {string[]}
+ */
 function getImports(conf) {
-    var imports = conf.get(importPath);
+    const imports = conf.get(importPath) || [];
 
-    imports = imports || [];
     if (typeof imports === 'string') {
-        imports = [imports];
+        return [imports];
     }
 
     return imports;
 }
 
 function install() {
-    var conf = new Configstore(packageName);
-    /** @type {string[]|string|undefined} */
-
-    var imports = getImports(conf);
+    const conf = new Configstore(packageName);
+    const imports = getImports(conf);
     if (imports.indexOf(configLocation) < 0) {
         imports.push(configLocation);
         conf.set(importPath, imports);
     }
 }
 
 function uninstall() {
-    var conf = new Configstore(packageName);
-    /** @type {string[]|string|undefined} */
-    var imports = getImports(conf);
-
-    var index = imports.indexOf(configLocation);
-
+    const conf = new Configstore(packageName);
+    const imports = getImports(conf);
+    const index = imports.indexOf(configLocation);
     if (index >= 0) {
         imports.splice(index, 1);
         conf.set(importPath, imports);

packages/aws/index.js

@@ -1,9 +1,9 @@
 'use strict';
 
-var util = require('./util');
+const configLocation = require.resolve('./cspell-ext.json');
 
 function getConfigLocation() {
-    return util.configLocation;
+    return configLocation;
 }
 
 module.exports = {

packages/aws/link.js

@@ -2,6 +2,6 @@
 
 'use strict';
 
-var util = require('./util');
+const util = require('./util');
 
 util.install();

packages/aws/package.json

@@ -6,6 +6,10 @@
     "cspell-dict-aws-link": "./link.js",
     "cspell-dict-aws-unlink": "./unlink.js"
   },
+  "exports": {
+    ".": "./index.js",
+    "./cspell-ext.json": "./cspell-ext.json"
+  },
   "scripts": {
     "build": "cspell-tools compile \"aws.txt\" -o .",
     "test": "head -n 100 \"aws.txt\" | cspell -v -c ./cspell-ext.json \"--local=*\" \"--languageId=aws\" stdin",

packages/aws/unlink.js

@@ -2,6 +2,6 @@
 
 'use strict';
 
-var util = require('./util');
+const util = require('./util');
 
 util.uninstall();

packages/aws/util.js

@@ -1,42 +1,40 @@
 'use strict';
 
 // Cspell:word configstore
-var Configstore = require('configstore');
-var Path = require('path');
+const Configstore = require('configstore');
 
-var packageName = 'cspell';
-var importPath = 'import';
-var configLocation = Path.join(__dirname, 'cspell-ext.json');
+const packageName = 'cspell';
+const importPath = 'import';
+const configLocation = require.resolve('./cspell-ext.json');
 
+/**
+ *
+ * @param {Configstore} conf
+ * @returns {string[]}
+ */
 function getImports(conf) {
-    var imports = conf.get(importPath);
+    const imports = conf.get(importPath) || [];
 
-    imports = imports || [];
     if (typeof imports === 'string') {
-        imports = [imports];
+        return [imports];
     }
 
     return imports;
 }
 
 function install() {
-    var conf = new Configstore(packageName);
-    /** @type {string[]|string|undefined} */
-
-    var imports = getImports(conf);
+    const conf = new Configstore(packageName);
+    const imports = getImports(conf);
     if (imports.indexOf(configLocation) < 0) {
         imports.push(configLocation);
         conf.set(importPath, imports);
     }
 }
 
 function uninstall() {
-    var conf = new Configstore(packageName);
-    /** @type {string[]|string|undefined} */
-    var imports = getImports(conf);
-
-    var index = imports.indexOf(configLocation);
-
+    const conf = new Configstore(packageName);
+    const imports = getImports(conf);
+    const index = imports.indexOf(configLocation);
     if (index >= 0) {
         imports.splice(index, 1);
         conf.set(importPath, imports);

packages/bash/index.js

@@ -1,9 +1,9 @@
 'use strict';
 
-var util = require('./util');
+const configLocation = require.resolve('./cspell-ext.json');
 
 function getConfigLocation() {
-    return util.configLocation;
+    return configLocation;
 }
 
 module.exports = {

packages/bash/link.js

@@ -2,6 +2,6 @@
 
 'use strict';
 
-var util = require('./util');
+const util = require('./util');
 
 util.install();

packages/bash/package.json

@@ -6,6 +6,10 @@
     "cspell-dict-bash-link": "./link.js",
     "cspell-dict-bash-unlink": "./unlink.js"
   },
+  "exports": {
+    ".": "./index.js",
+    "./cspell-ext.json": "./cspell-ext.json"
+  },
   "scripts": {
     "build": "cspell-tools compile \"bash-words.txt\" -o .",
     "test": "head -n 100 \"bash-words.txt\" | cspell -v -c ./cspell-ext.json \"--local=*\" \"--languageId=shellscript\" stdin",

packages/bash/unlink.js

@@ -2,6 +2,6 @@
 
 'use strict';
 
-var util = require('./util');
+const util = require('./util');
 
 util.uninstall();

packages/bash/util.js

@@ -1,42 +1,40 @@
 'use strict';
 
 // Cspell:word configstore
-var Configstore = require('configstore');
-var Path = require('path');
+const Configstore = require('configstore');
 
-var packageName = 'cspell';
-var importPath = 'import';
-var configLocation = Path.join(__dirname, 'cspell-ext.json');
+const packageName = 'cspell';
+const importPath = 'import';
+const configLocation = require.resolve('./cspell-ext.json');
 
+/**
+ *
+ * @param {Configstore} conf
+ * @returns {string[]}
+ */
 function getImports(conf) {
-    var imports = conf.get(importPath);
+    const imports = conf.get(importPath) || [];
 
-    imports = imports || [];
     if (typeof imports === 'string') {
-        imports = [imports];
+        return [imports];
     }
 
     return imports;
 }
 
 function install() {
-    var conf = new Configstore(packageName);
-    /** @type {string[]|string|undefined} */
-
-    var imports = getImports(conf);
+    const conf = new Configstore(packageName);
+    const imports = getImports(conf);
     if (imports.indexOf(configLocation) < 0) {
         imports.push(configLocation);
         conf.set(importPath, imports);
     }
 }
 
 function uninstall() {
-    var conf = new Configstore(packageName);
-    /** @type {string[]|string|undefined} */
-    var imports = getImports(conf);
-
-    var index = imports.indexOf(configLocation);
-
+    const conf = new Configstore(packageName);
+    const imports = getImports(conf);
+    const index = imports.indexOf(configLocation);
     if (index >= 0) {
         imports.splice(index, 1);
         conf.set(importPath, imports);

packages/bg_BG/index.js

@@ -1,9 +1,9 @@
 'use strict';
 
-var util = require('./util');
+const configLocation = require.resolve('./cspell-ext.json');
 
 function getConfigLocation() {
-    return util.configLocation;
+    return configLocation;
 }
 
 module.exports = {

packages/bg_BG/link.js

@@ -2,6 +2,6 @@
 
 'use strict';
 
-var util = require('./util');
+const util = require('./util');
 
 util.install();

packages/bg_BG/package.json

@@ -6,6 +6,10 @@
     "cspell-dict-bg-bg-link": "./link.js",
     "cspell-dict-bg-bg-unlink": "./unlink.js"
   },
+  "exports": {
+    ".": "./index.js",
+    "./cspell-ext.json": "./cspell-ext.json"
+  },
   "scripts": {
     "build": "cspell-tools compile-trie \"bg_BG.dic\" -o .",
     "test": "hunspell-reader words -n 1000 \"bg_BG.dic\" | cspell -v -c ./cspell-ext.json \"--local=bg\" \"--languageId=*\" stdin",

packages/bg_BG/unlink.js

@@ -2,6 +2,6 @@
 
 'use strict';
 
-var util = require('./util');
+const util = require('./util');
 
 util.uninstall();