forked from zulip/zulip-mobile
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
wip tool to find dangling message IDs in messages_en.json
Run with:
node tools/check-messages-en.js
TODO:
- Incorporate into tools/test, perhaps to run only when --all-files
requested
- Type-check this file with Flow?
- Think of any more ways to keep non-UI strings out of
possibleUiStringLiterals
- See discussion:
https://chat.zulip.org/#narrow/stream/243-mobile-team/topic/Strings.20in.20messages_en.2Ejson.20but.20not.20in.20the.20app/near/1425315
Add flow-parser at <0.159.0. We'd like a later version -- probably
ideal would be to sync it with flow-bin, which is ^0.162.0 right now
-- but facebook/flow@5de4ea57e, released in v0.159.0, was a change
that isn't yet handled by any version of ast-types [1]. A fix for
ast-types is open as the issue benjamn/ast-types#728 and PR
benjamn/ast-types#727.
[1] I get this error output:
/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/types.js:664
throw new Error("did not recognize object of type " +
^
Error: did not recognize object of type "PropertyDefinition"
at Object.getFieldNames (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/types.js:664:19)
at visitChildren (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path-visitor.js:184:36)
at Visitor.PVp.visitWithoutReset (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path-visitor.js:166:20)
at NodePath.each (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path.js:87:26)
at visitChildren (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path-visitor.js:178:18)
at Visitor.PVp.visitWithoutReset (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path-visitor.js:166:20)
at visitChildren (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path-visitor.js:203:25)
at Visitor.PVp.visitWithoutReset (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path-visitor.js:166:20)
at visitChildren (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path-visitor.js:203:25)
at Visitor.PVp.visitWithoutReset (/Users/chrisbobbe/dev/zulip-mobile/node_modules/ast-types/lib/path-visitor.js:166:20)- Loading branch information
1 parent
40934bf
commit 0cd4245
Showing
3 changed files
with
158 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| const fs = require('fs'); | ||
| const path = require('path'); | ||
| const { namedTypes: n, visit } = require('ast-types'); | ||
| const flowParser = require('flow-parser'); | ||
| const { parse } = require('recast'); | ||
|
|
||
| const messages_en = require('../static/translations/messages_en.json'); | ||
|
|
||
| // Make a list of files that might contain UI strings, by recursing in src/. | ||
| const possibleUIStringFilePaths = []; | ||
| const kSrcDirName = 'src/'; | ||
| function walk(dir, _dirName = '') { | ||
| let dirent; | ||
| // eslint-disable-next-line no-cond-assign | ||
| while ((dirent = dir.readSync())) { | ||
| // To reduce false negatives, `continue` when nothing in `dirent` can | ||
| // cause UI strings to appear in the app. | ||
|
|
||
| if (dirent.isFile()) { | ||
| // Non-JS code, and Flow type definitions in .js.flow files. | ||
| if (!dirent.name.endsWith('.js')) { | ||
| continue; | ||
| } | ||
|
|
||
| possibleUIStringFilePaths.push(path.join(kSrcDirName, _dirName, dirent.name)); | ||
| } else if (dirent.isDirectory()) { | ||
| const subdirName = path.join(_dirName, dirent.name); | ||
|
|
||
| // Test code. | ||
| if (subdirName.endsWith('__tests__')) { | ||
| continue; | ||
| } | ||
|
|
||
| walk(fs.opendirSync(path.join(kSrcDirName, subdirName)), subdirName); | ||
| } else { | ||
| // Something we don't expect to find under src/, probably containing | ||
| // no UI strings. (symlinks? fifos, sockets, devices??) | ||
| continue; | ||
| } | ||
| } | ||
| } | ||
| walk(fs.opendirSync(kSrcDirName)); | ||
|
|
||
| const parseOptions = { | ||
| parser: { | ||
| parse(src) { | ||
| return flowParser.parse(src, { | ||
| // Comments can't cause UI strings to appear in the app; ignore them. | ||
| all_comments: false, | ||
| comments: false, | ||
|
|
||
| // We plan to use Flow enums; the parser shouldn't crash on them. | ||
| enums: true, | ||
|
|
||
| // Set `tokens: true` just to work around a mysterious error. | ||
| // | ||
| // From the doc for this option: | ||
| // | ||
| // > include a list of all parsed tokens in a top-level tokens | ||
| // > property | ||
| // | ||
| // We don't actually want this list of tokens. String literals do | ||
| // get represented in the list, but as tokens, i.e., meaningful | ||
| // chunks of the literal source code. They come with surrounding | ||
| // quotes, escape syntax, etc: | ||
| // | ||
| // 'doesn\'t' | ||
| // "doesn't" | ||
| // | ||
| // What we really want is the *value* of a string literal: | ||
| // | ||
| // doesn't | ||
| // | ||
| // and we get that from the AST. | ||
| // | ||
| // Anyway, we set `true` for this because otherwise I've been seeing | ||
| // `parse` throw an error: | ||
| // | ||
| // Error: Line 72: Invalid regular expression: missing / | ||
| // | ||
| // TODO: Debug and/or file an issue upstream. | ||
| tokens: true, | ||
| }); | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| // Look at all files in possibleUIStringFilePaths, and collect all string | ||
| // literals that might represent UI strings. | ||
| const possibleUiStringLiterals = new Set(); | ||
| possibleUIStringFilePaths.forEach(filePath => { | ||
| const source = fs.readFileSync(filePath).toString(); | ||
| const ast = parse(source, parseOptions); | ||
|
|
||
| visit(ast, { | ||
| // Find nodes with type "Literal" in the AST. | ||
| /* eslint-disable no-shadow */ | ||
| visitLiteral(path) { | ||
| // To reduce false negatives, return false when `path` definitely | ||
| // doesn't represent a string literal for a UI string in the app. | ||
|
|
||
| const { value } = path.value; | ||
|
|
||
| // Non-string literals: numbers, booleans, etc. | ||
| if (typeof value !== 'string') { | ||
| return false; | ||
| } | ||
|
|
||
| // String literals like 'react' in lines like | ||
| // import React from 'react'; | ||
| if (n.ImportDeclaration.check(path.parent.value)) { | ||
| return false; | ||
| } | ||
|
|
||
| possibleUiStringLiterals.add(value); | ||
|
|
||
| return this.traverse(path); | ||
| }, | ||
| }); | ||
| }); | ||
|
|
||
| // Check each key ("message ID" in formatjs's lingo) against | ||
| // possibleUiStringLiterals, and make a list of any that aren't found. | ||
| const danglingMessageIds = Object.keys(messages_en).filter( | ||
| messageId => !possibleUiStringLiterals.has(messageId), | ||
| ); | ||
|
|
||
| if (danglingMessageIds.length > 0) { | ||
| console.warn( | ||
| "Found message IDs in static/translations/messages_en.json that don't seem to be used in the app:", | ||
| ); | ||
| console.warn(danglingMessageIds); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters