Fix linting

Author: docd27

.eslintrc.js

@@ -0,0 +1,36 @@
+{
+  "env": {
+    "es2021": true,
+    "node": true,
+    "mocha": true
+  },
+  "extends": [
+    "eslint:recommended", "google"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 2021, // ecma2021
+    "sourceType": "module"
+  },
+  "rules": {
+    "require-jsdoc": "off",
+    "no-constant-condition": ["error", {"checkLoops": false}], /* while(true) is a common and useful idiom */
+    "no-inner-declarations": "off",
+
+    /* Formatting annoyances: */
+    "max-len": ["error", {"code": 120, "ignoreComments": true, "ignoreTrailingComments": true}],
+    "no-trailing-spaces": ["error", {"skipBlankLines": true, "ignoreComments": true}],
+    "no-multiple-empty-lines": "off",
+    "padded-blocks": "off",
+    "one-var": "off",
+    "no-multi-spaces": "off",
+    "computed-property-spacing": "off",
+
+    "new-cap": "off", /* Just causes problems with callbacks */
+
+    "valid-jsdoc": "off", /* Eslint can't parse closure/typescript complex types */
+
+    /* Make into warnings - these are common when prototyping code: */
+    "no-unused-vars": "warn",
+    "prefer-const": "warn"
+  }
+}

.eslintrc.json

@@ -18,7 +18,7 @@ coverage/
 # actually *lowers* npm's quality score :(
 
 # Dev env
-# .eslintrc.js
+# .eslintrc.json
 # jsconfig.json
 # tsconfig.json
 

.npmignore

@@ -16,7 +16,7 @@ export default {
         win64: ['bin/glslangValidator.exe'],
         ubuntu64: ['bin/glslangValidator'],
         macos64: ['bin/glslangValidator'],
-      }
+      },
     },
     {
       name: 'spirv-opt',
@@ -29,15 +29,15 @@ export default {
         macos64: 'https://storage.googleapis.com/spirv-tools/badges/build_link_macos_clang_release.html',
       },
       matchers: {
-        win64: /windows.*\/([^-\/]+)-[^\/]+\/([^\/]+)$/i,
-        ubuntu64: /linux.*\/([^-\/]+)-[^\/]+\/([^\/]+)$/i,
-        macos64: /macos.*\/([^-\/]+)-[^\/]+\/([^\/]+)$/i,
+        win64: /windows.*\/([^-/]+)-[^/]+\/([^/]+)$/i,
+        ubuntu64: /linux.*\/([^-/]+)-[^/]+\/([^/]+)$/i,
+        macos64: /macos.*\/([^-/]+)-[^/]+\/([^/]+)$/i,
       },
       filelist: {
         win64: ['install/bin/spirv-opt.exe'],
         ubuntu64: ['install/bin/spirv-opt'],
         macos64: ['install/bin/spirv-opt'],
-      }
+      },
     },
     {
       name: 'spirv-cross',
@@ -62,22 +62,22 @@ export default {
       name: 'glslangValidator LICENSE',
       url: 'https://raw.githubusercontent.com/KhronosGroup/glslang/master/LICENSE.txt',
       fileList: [
-        'glslangValidator-LICENSE'
-      ]
+        'glslangValidator-LICENSE',
+      ],
     },
     {
       name: 'spirv-opt LICENSE',
       url: 'https://raw.githubusercontent.com/KhronosGroup/SPIRV-Tools/master/LICENSE',
       fileList: [
-        'spirv-opt-LICENSE'
-      ]
+        'spirv-opt-LICENSE',
+      ],
     },
     {
       name: 'spirv-cross LICENSE',
       url: 'https://raw.githubusercontent.com/KhronosGroup/SPIRV-Cross/master/LICENSE',
       fileList: [
-        'spirv-cross-LICENSE'
-      ]
-    }
+        'spirv-cross-LICENSE',
+      ],
+    },
   ],
 };

build.binaries.config.mjs

@@ -98,7 +98,7 @@ const runBuildFetchStep = async (buildStep, targetDir) => {
 async function jsonRequest(url) {
   try {
     const response = await fetch(url, {
-      method: 'GET'
+      method: 'GET',
     });
     if (!response.ok) throw new Error(`Bad response code: ${response.status}`);
     return response.json();
@@ -119,9 +119,9 @@ async function fetchMatchingGithubRelease(repo, releaseMatchers) {
   }
   let foundReleaseInfo;
   for (const releaseInfo of releaseInfos) {
-    if (releaseInfo.draft // Skip draft releases
-      || !releaseInfo.html_url || !releaseInfo.created_at || !releaseInfo.target_commitish // Missing info
-      || !releaseInfo.assets || !releaseInfo.assets.length // No assets
+    if (releaseInfo.draft || // Skip draft releases
+      !releaseInfo.html_url || !releaseInfo.created_at || !releaseInfo.target_commitish || // Missing info
+      !releaseInfo.assets || !releaseInfo.assets.length // No assets
     ) continue;
 
     const matchAssets = new Set(releaseInfo.assets);
@@ -146,9 +146,10 @@ async function fetchMatchingGithubRelease(repo, releaseMatchers) {
         url: releaseInfo.html_url,
         hash: releaseInfo.target_commitish,
         date: releaseInfo.created_at,
-        tag: new Date(releaseInfo.created_at).toISOString().split('T')[0] + '-' + releaseInfo.target_commitish.slice(0, 7),
+        tag: new Date(releaseInfo.created_at).toISOString().split('T')[0] +
+            '-' + releaseInfo.target_commitish.slice(0, 7),
         platforms: matchedPlats,
-      }
+      };
       break;
     } else {
       // We could continue searching down releases, but better to throw an error in case
@@ -170,7 +171,7 @@ async function fetchSpirvToolsCIPage(url) {
   let resultHTML;
   try {
     const response = await fetch(url, {
-      method: 'GET'
+      method: 'GET',
     });
     if (!response.ok) throw new Error(`Bad response code: ${response.status}`);
     resultHTML = await response.text();
@@ -221,7 +222,9 @@ async function fetchMatchingSpirvToolsCI(urls, releaseMatchers) {
   if (!thisPlat) throw new Error(`Couldn't identify this platform's tag`);
 
   const buildConfig = /** @type {BuildConfig} */((await import('./build.binaries.config.mjs')).default);
-  if (!buildConfig || !buildConfig.targets || !buildConfig.sources || !buildConfig.include) throw new Error(`Bad build config`);
+  if (!buildConfig || !buildConfig.targets || !buildConfig.sources || !buildConfig.include) {
+    throw new Error(`Bad build config`);
+  }
 
   rmFile(buildInfoFile);
   rmDir(buildFolder);
@@ -234,16 +237,17 @@ async function fetchMatchingSpirvToolsCI(urls, releaseMatchers) {
     switch (source.type) {
       case 'githubrelease':
         sourceResult = await fetchMatchingGithubRelease(source.repo, source.matchers);
-      break;
+        break;
       case 'spirvtoolsci':
         sourceResult = await fetchMatchingSpirvToolsCI(source.urls, source.matchers);
-      break;
+        break;
       default: throw new Error(`build config error: Unknown type '${source.type}' for source '${source.name}'`);
     }
     for (const target of buildConfig.targets) {
       if (!sourceResult.platforms[target]) throw new Error(`source '${source.name}' missing target '${target}'`);
     }
-    sources.push({...sourceResult, name: source.name, filelist: source.filelist, verargs: source.verargs, vermatch: source.vermatch});
+    sources.push({...sourceResult, name: source.name, filelist: source.filelist,
+      verargs: source.verargs, vermatch: source.vermatch});
   }
 
   const includeFiles = [];
@@ -265,7 +269,7 @@ async function fetchMatchingSpirvToolsCI(urls, releaseMatchers) {
 
     for (const source of sources) {
       const url = source.platforms[target].url;
-      const extMatch = url.match(/\.(tar\.gz|tgz|zip)$/i) || ['',''];
+      const extMatch = url.match(/\.(tar\.gz|tgz|zip)$/i) || ['', ''];
       let action;
       switch (extMatch[1].toLowerCase()) {
         case 'tar.gz': case 'tgz': action = 'untargz'; break;

build.binaries.mjs

@@ -65,7 +65,7 @@
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "del": "^6.0.0",
-    "eslint": "^7.22.0",
+    "eslint": "^7.25.0",
     "eslint-config-google": "^0.14.0",
     "he": "^1.2.0",
     "mocha": "^8.3.2",

package-lock.json

@@ -1,5 +1,5 @@
 import {createFilter} from '@rollup/pluginutils';
-import { glslProcessSource } from './lib/glslProcess.js';
+import {glslProcessSource} from './lib/glslProcess.js';
 import {dirname} from 'path';
 import * as fsSync from 'fs';
 
@@ -8,28 +8,28 @@ import * as fsSync from 'fs';
  * @typedef {{[P in GLSLStageName]: string[]}} GLSLStageDefs */
 /** @type {GLSLStageDefs} */
 const stageDefs = {
-  'vert': [ '.vs', '.vert', '.vs.glsl', '.vert.glsl' ],
-  'frag': [ '.fs', '.frag', '.fs.glsl', '.frag.glsl' ],
+  'vert': ['.vs', '.vert', '.vs.glsl', '.vert.glsl'],
+  'frag': ['.fs', '.frag', '.fs.glsl', '.frag.glsl'],
   // The following are untested:
-  'geom': [ '.geom', '.geom.glsl' ],
-  'comp': [ '.comp', '.comp.glsl' ],
-  'tesc': [ '.tesc', '.tesc.glsl' ],
-  'tese': [ '.tese', '.tese.glsl' ],
+  'geom': ['.geom', '.geom.glsl'],
+  'comp': ['.comp', '.comp.glsl'],
+  'tesc': ['.tesc', '.tesc.glsl'],
+  'tese': ['.tese', '.tese.glsl'],
 };
 
 const extsIncludeDefault = [...Object.values(stageDefs).flatMap(
-  (exts) => exts.map((ext) => `**/*${ext}`)),
-  '**/*.glsl',
+    (exts) => exts.map((ext) => `**/*${ext}`)),
+'**/*.glsl',
   // Additionally include all *.glsl by default so we throw an error
   // if the user includes a file extension without a stage
 ];
 
 /** @type {[GLSLStageName, RegExp][]} */
 const stageRegexes = (
   /** @type {[GLSLStageName, string[]][]} */(Object.entries(stageDefs))
-  .map(([st, exts]) => [st,
-    new RegExp(`(?:${exts.map(ext => ext.replace('.', '\\.')).join('|')})$`, 'i')
-  ]));
+      .map(([st, exts]) => [st,
+        new RegExp(`(?:${exts.map((ext) => ext.replace('.', '\\.')).join('|')})$`, 'i'),
+      ]));
 
 function generateCode(source) {
   return `export default ${JSON.stringify(source)}; // eslint-disable-line`;
@@ -83,7 +83,9 @@ export default function glslOptimize(userOptions = {}) {
           if (glslify && glslify.compile && typeof glslify.compile === 'function') {
             glslifyCompile = glslify.compile;
           }
-        } catch {}
+        } catch {
+          // do nothing
+        }
       }
       return options;
     },
@@ -107,22 +109,22 @@ export default function glslOptimize(userOptions = {}) {
       /** @type {GLSLStageName} */
       const stage = stageRegexes.find(([, regex]) => id.match(regex))?.[0];
       if (!stage) {
-        this.error({ message: `File '${id}' : extension did not match a shader stage.` });
+        this.error({message: `File '${id}' : extension did not match a shader stage.`});
       }
 
       if (pluginOptions.glslify) {
         if (!glslifyCompile) {
-          this.error({ message: `glslify could not be found. Install it with npm i -D glslify`});
+          this.error({message: `glslify could not be found. Install it with npm i -D glslify`});
         }
         /** @type {GlslifyOptions} */
         const glslifyOptions = {
           basedir: dirname(id),
           ...pluginOptions.glslifyOptions,
-        }
+        };
         try {
           source = glslifyCompile(source, glslifyOptions);
         } catch (err) {
-          this.error({ message: `Error processing GLSL source with glslify:\n${err.message}` });
+          this.error({message: `Error processing GLSL source with glslify:\n${err.message}`});
         }
       }
 
@@ -131,7 +133,7 @@ export default function glslOptimize(userOptions = {}) {
         result.code = generateCode(result.code);
         return result;
       } catch (err) {
-        this.error({ message: `Error processing GLSL source:\n${err.message}` });
+        this.error({message: `Error processing GLSL source:\n${err.message}`});
       }
     },
   };