Convert localization plugin to use ESLint.

iclanton · iclanton · commit dcd2ac017c10 · 2020-01-27T17:54:03.000-08:00
diff --git a/webpack/localization-plugin/.eslintrc.js b/webpack/localization-plugin/.eslintrc.js
@@ -0,0 +1,7 @@
+// This is a workaround for https://github.com/eslint/eslint/issues/3458
+require("@rushstack/eslint-config/patch-eslint6");
+
+module.exports = {
+  extends: [ "@rushstack/eslint-config" ],
+  parserOptions: { tsconfigRootDir: __dirname },
+};
diff --git a/webpack/localization-plugin/package.json b/webpack/localization-plugin/package.json
@@ -31,6 +31,7 @@
     "@types/webpack": "4.39.8",
     "@microsoft/rush-stack-compiler-3.5": "0.4.2",
     "@microsoft/node-library-build": "6.4.3",
+    "@rushstack/eslint-config": "0.5.4",
     "@types/glob": "7.1.1",
     "@types/loader-utils": "1.1.3",
     "@types/jju": "1.4.1",
diff --git a/webpack/localization-plugin/src/LocJsonPreprocessor.ts b/webpack/localization-plugin/src/LocJsonPreprocessor.ts
@@ -65,7 +65,7 @@ export class LocJsonPreprocessor {
       ];
 
       const locJsonFile: ILocJsonFile = JsonFile.loadAndValidate(locJsonFilePath, locJsonSchema);
-      for (const stringName in locJsonFile) { // tslint:disable-line:forin
+      for (const stringName in locJsonFile) { // eslint-disable-line guard-for-in
         const { comment } = locJsonFile[stringName];
 
         if (comment.trim()) {
diff --git a/webpack/localization-plugin/src/LocalizationPlugin.ts b/webpack/localization-plugin/src/LocalizationPlugin.ts
@@ -142,7 +142,7 @@ export class LocalizationPlugin implements Webpack.Plugin {
    */
   private _resolvedLocalizedStrings: Map<string, Map<string, Map<string, string>>>;
 
-  constructor(options: ILocalizationPluginOptions) {
+  public constructor(options: ILocalizationPluginOptions) {
     this._options = options;
   }
 
@@ -319,7 +319,7 @@ export class LocalizationPlugin implements Webpack.Plugin {
 
     let lastIndex: number = 0;
     let regexResult: RegExpExecArray | null;
-    while (regexResult = placeholderRegex.exec(assetSource)) {
+    while (regexResult = placeholderRegex.exec(assetSource)) { // eslint-disable-line no-cond-assign
       const staticElement: IStaticReconstructionElement = {
         kind: 'static',
         staticString: assetSource.substring(lastIndex, regexResult.index)
@@ -472,7 +472,7 @@ export class LocalizationPlugin implements Webpack.Plugin {
     const errors: Error[] = [];
 
     // START configuration
-    {
+    { // eslint-disable-line no-lone-blocks
       if (
         !configuration.output ||
         !configuration.output.filename ||
@@ -488,7 +488,7 @@ export class LocalizationPlugin implements Webpack.Plugin {
     // END configuration
 
     // START options.filesToIgnore
-    {
+    { // eslint-disable-line no-lone-blocks
       this._locJsonFilesToIgnore = new Set<string>();
       for (const locJsonFilePath of this._options.filesToIgnore || []) {
         let normalizedLocJsonFilePath: string = path.resolve(configuration.context!, locJsonFilePath);
@@ -499,7 +499,7 @@ export class LocalizationPlugin implements Webpack.Plugin {
     // END options.filesToIgnore
 
     // START options.localizedStrings
-    {
+    { // eslint-disable-line no-lone-blocks
       const { localizedStrings } = this._options;
 
       const localeNameRegex: RegExp = /[a-z-]/i;
@@ -632,7 +632,7 @@ export class LocalizationPlugin implements Webpack.Plugin {
     // END options.localizedStrings
 
     // START options.defaultLocale
-    {
+    { // eslint-disable-line no-lone-blocks
       if (
         !this._options.defaultLocale ||
         (!this._options.defaultLocale.locale && !this._options.defaultLocale.usePassthroughLocale)
diff --git a/webpack/localization-plugin/src/loaders/LocJsonLoader.ts b/webpack/localization-plugin/src/loaders/LocJsonLoader.ts
@@ -12,14 +12,13 @@ export interface ILocJsonLoaderOptions {
   pluginInstance: LocalizationPlugin;
 }
 
-// tslint:disable-next-line:no-function-expression
 export default function (this: loader.LoaderContext, content: string): string {
   const { pluginInstance } = loaderUtils.getOptions(this) as ILocJsonLoaderOptions;
   const locJsonFilePath: string = this.resourcePath;
   const locJsonFileData: ILocJsonFile = jju.parse(content);
 
   const resultObject: { [stringName: string]: string } = {};
-  for (const stringName in locJsonFileData) { // tslint:disable-line:forin
+  for (const stringName in locJsonFileData) { // eslint-disable-line guard-for-in
     const stringKey: string = `${locJsonFilePath.toUpperCase()}?${stringName}`;
     if (pluginInstance.stringKeys.has(stringKey)) {
       resultObject[stringName] = pluginInstance.stringKeys.get(stringKey)!.value;
diff --git a/webpack/localization-plugin/src/loaders/LocJsonWarningLoader.ts b/webpack/localization-plugin/src/loaders/LocJsonWarningLoader.ts
@@ -3,7 +3,6 @@
 
 import { loader } from 'webpack';
 
-// tslint:disable-next-line:no-function-expression
 export default function (this: loader.LoaderContext, content: string): string {
   const locJsonFilePath: string = this.resourcePath;
   this.emitError(new Error(
diff --git a/webpack/localization-plugin/src/loaders/SingleLocaleLoader.ts b/webpack/localization-plugin/src/loaders/SingleLocaleLoader.ts
@@ -20,7 +20,6 @@ export interface ILocJsonLoaderOptions {
   passthroughLocale: boolean;
 }
 
-// tslint:disable-next-line:no-function-expression
 export default function (this: loader.LoaderContext, content: string): string {
   const {
     resolvedStrings,
@@ -38,7 +37,7 @@ export default function (this: loader.LoaderContext, content: string): string {
       ));
   } else {
     const locJsonFileData: ILocJsonFile = jju.parse(content);
-    for (const stringName in locJsonFileData) { // tslint:disable-line:forin
+    for (const stringName in locJsonFileData) {
       if (!stringMap.has(stringName)) {
         this.emitError(new Error(
           `String "${stringName}" in file ${locJsonFilePath} was not provided in the LocalizationPlugin configuration.`
diff --git a/webpack/localization-plugin/tslint.json b/webpack/localization-plugin/tslint.json
