fix(localize): update type castings for JSON.parse usage (#40710)

josephperrott · alxhub · commit 4b469c960e90 · 2021-02-09T10:48:43.000-08:00
Update usages of JSON.parse to be cast as specific types. PR Close #40710
diff --git a/packages/localize/schematics/ng-add/index_spec.ts b/packages/localize/schematics/ng-add/index_spec.ts
@@ -177,18 +177,20 @@ export { renderModule, renderModuleFactory } from '@angular/platform-server';`;
   it('should add package to `devDependencies` by default', async () => {
     host = await schematicRunner.runSchematicAsync('ng-add', defaultOptions, host).toPromise();
     const packageJsonText = host.readContent('/package.json');
-    expect(JSON.parse(packageJsonText).devDependencies?.['@angular/localize'])
-        .toBe('~0.0.0-PLACEHOLDER');
-    expect(JSON.parse(packageJsonText).dependencies?.['@angular/localize']).toBeUndefined();
+    const packageJsonObj = JSON.parse(packageJsonText) as
+        {devDependencies: {[key: string]: string}, dependencies: {[key: string]: string}};
+    expect(packageJsonObj.devDependencies?.['@angular/localize']).toBe('~0.0.0-PLACEHOLDER');
+    expect(packageJsonObj.dependencies?.['@angular/localize']).toBeUndefined();
   });
 
   it('should add package to `dependencies` if `useAtRuntime` is `true`', async () => {
     host = await schematicRunner
                .runSchematicAsync('ng-add', {...defaultOptions, useAtRuntime: true}, host)
                .toPromise();
     const packageJsonText = host.readContent('/package.json');
-    expect(JSON.parse(packageJsonText).dependencies?.['@angular/localize'])
-        .toBe('~0.0.0-PLACEHOLDER');
-    expect(JSON.parse(packageJsonText).devDependencies?.['@angular/localize']).toBeUndefined();
+    const packageJsonObj = JSON.parse(packageJsonText) as
+        {devDependencies: {[key: string]: string}, dependencies: {[key: string]: string}};
+    expect(packageJsonObj.dependencies?.['@angular/localize']).toBe('~0.0.0-PLACEHOLDER');
+    expect(packageJsonObj.devDependencies?.['@angular/localize']).toBeUndefined();
   });
 });
diff --git a/packages/localize/src/tools/src/extract/translation_files/format_options.ts b/packages/localize/src/tools/src/extract/translation_files/format_options.ts
@@ -40,5 +40,5 @@ export function validateOptions(name: string, validOptions: ValidOptions, option
  * @param optionString The string to parse.
  */
 export function parseFormatOptions(optionString: string = '{}'): FormatOptions {
-  return JSON.parse(optionString);
-}
+  return JSON.parse(optionString) as FormatOptions;
+}
diff --git a/packages/localize/src/tools/src/translate/translation_files/translation_parsers/arb_translation_parser.ts b/packages/localize/src/tools/src/translate/translation_files/translation_parsers/arb_translation_parser.ts
@@ -93,7 +93,7 @@ export class ArbTranslationParser implements TranslationParser<ArbJsonObject> {
   }
 
   private tryParseArbFormat(contents: string): ArbJsonObject {
-    const json = JSON.parse(contents);
+    const json = JSON.parse(contents) as ArbJsonObject;
     if (typeof json['@@locale'] !== 'string') {
       throw new Error('Missing @@locale property.');
     }
diff --git a/packages/localize/src/tools/src/translate/translation_files/translation_parsers/simple_json_translation_parser.ts b/packages/localize/src/tools/src/translate/translation_files/translation_parsers/simple_json_translation_parser.ts
@@ -11,6 +11,11 @@ import {Diagnostics} from '../../../diagnostics';
 
 import {ParseAnalysis, ParsedTranslationBundle, TranslationParser} from './translation_parser';
 
+interface SimpleJsonFile {
+  locale: string;
+  translations: {[messageId: string]: string};
+}
+
 /**
  * A translation parser that can parse JSON that has the form:
  *
@@ -27,16 +32,16 @@ import {ParseAnalysis, ParsedTranslationBundle, TranslationParser} from './trans
  * @see SimpleJsonTranslationSerializer
  * @publicApi used by CLI
  */
-export class SimpleJsonTranslationParser implements TranslationParser<Object> {
+export class SimpleJsonTranslationParser implements TranslationParser<SimpleJsonFile> {
   /**
    * @deprecated
    */
-  canParse(filePath: string, contents: string): Object|false {
+  canParse(filePath: string, contents: string): SimpleJsonFile|false {
     const result = this.analyze(filePath, contents);
     return result.canParse && result.hint;
   }
 
-  analyze(filePath: string, contents: string): ParseAnalysis<Object> {
+  analyze(filePath: string, contents: string): ParseAnalysis<SimpleJsonFile> {
     const diagnostics = new Diagnostics();
     // For this to be parsable, the extension must be `.json` and the contents must include "locale"
     // and "translations" keys.
@@ -46,7 +51,7 @@ export class SimpleJsonTranslationParser implements TranslationParser<Object> {
       return {canParse: false, diagnostics};
     }
     try {
-      const json = JSON.parse(contents);
+      const json = JSON.parse(contents) as SimpleJsonFile;
       if (json.locale === undefined) {
         diagnostics.warn('Required "locale" property missing.');
         return {canParse: false, diagnostics};
@@ -70,8 +75,8 @@ export class SimpleJsonTranslationParser implements TranslationParser<Object> {
     }
   }
 
-  parse(_filePath: string, contents: string, json?: Object): ParsedTranslationBundle {
-    const {locale: parsedLocale, translations} = json || JSON.parse(contents);
+  parse(_filePath: string, contents: string, json?: SimpleJsonFile): ParsedTranslationBundle {
+    const {locale: parsedLocale, translations} = json || JSON.parse(contents) as SimpleJsonFile;
     const parsedTranslations: Record<ɵMessageId, ɵParsedTranslation> = {};
     for (const messageId in translations) {
       const targetMessage = translations[messageId];

Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ export class ArbTranslationParser implements TranslationParser<ArbJsonObject> {`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`private tryParseArbFormat(contents: string): ArbJsonObject {`
`96`		`- const json = JSON.parse(contents);`
	`96`	`+ const json = JSON.parse(contents) as ArbJsonObject;`
`97`	`97`	`if (typeof json['@@locale'] !== 'string') {`
`98`	`98`	`throw new Error('Missing @@locale property.');`
`99`	`99`	`}`