|
| 1 | +const fs = require('fs'); |
| 2 | +const path = require('path'); |
| 3 | +const { namedTypes: n, visit } = require('ast-types'); |
| 4 | +const flowParser = require('flow-parser'); |
| 5 | +const { parse } = require('recast'); |
| 6 | + |
| 7 | +const messages_en = require('../static/translations/messages_en.json'); |
| 8 | + |
| 9 | +// Make a list of files that might contain UI strings, by recursing in src/. |
| 10 | +const possibleUIStringFilePaths = []; |
| 11 | +const kSrcDirName = 'src/'; |
| 12 | +function walk(dir, _dirName = '') { |
| 13 | + let dirent; |
| 14 | + // eslint-disable-next-line no-cond-assign |
| 15 | + while ((dirent = dir.readSync())) { |
| 16 | + // To reduce false negatives, `continue` when nothing in `dirent` can |
| 17 | + // cause UI strings to appear in the app. |
| 18 | + |
| 19 | + if (dirent.isFile()) { |
| 20 | + // Non-JS code, and Flow type definitions in .js.flow files. |
| 21 | + if (!dirent.name.endsWith('.js')) { |
| 22 | + continue; |
| 23 | + } |
| 24 | + |
| 25 | + possibleUIStringFilePaths.push(path.join(kSrcDirName, _dirName, dirent.name)); |
| 26 | + } else if (dirent.isDirectory()) { |
| 27 | + const subdirName = path.join(_dirName, dirent.name); |
| 28 | + |
| 29 | + // Test code. |
| 30 | + if (subdirName.endsWith('__tests__')) { |
| 31 | + continue; |
| 32 | + } |
| 33 | + |
| 34 | + walk(fs.opendirSync(path.join(kSrcDirName, subdirName)), subdirName); |
| 35 | + } else { |
| 36 | + // Something we don't expect to find under src/, probably containing |
| 37 | + // no UI strings. (symlinks? fifos, sockets, devices??) |
| 38 | + continue; |
| 39 | + } |
| 40 | + } |
| 41 | +} |
| 42 | +walk(fs.opendirSync(kSrcDirName)); |
| 43 | + |
| 44 | +const parseOptions = { |
| 45 | + parser: { |
| 46 | + parse(src) { |
| 47 | + return flowParser.parse(src, { |
| 48 | + // Comments can't cause UI strings to appear in the app; ignore them. |
| 49 | + all_comments: false, |
| 50 | + comments: false, |
| 51 | + |
| 52 | + // We plan to use Flow enums; the parser shouldn't crash on them. |
| 53 | + enums: true, |
| 54 | + |
| 55 | + // Set `tokens: true` just to work around a mysterious error. |
| 56 | + // |
| 57 | + // From the doc for this option: |
| 58 | + // |
| 59 | + // > include a list of all parsed tokens in a top-level tokens |
| 60 | + // > property |
| 61 | + // |
| 62 | + // We don't actually want this list of tokens. String literals do |
| 63 | + // get represented in the list, but as tokens, i.e., meaningful |
| 64 | + // chunks of the literal source code. They come with surrounding |
| 65 | + // quotes, escape syntax, etc: |
| 66 | + // |
| 67 | + // 'doesn\'t' |
| 68 | + // "doesn't" |
| 69 | + // |
| 70 | + // What we really want is the *value* of a string literal: |
| 71 | + // |
| 72 | + // doesn't |
| 73 | + // |
| 74 | + // and we get that from the AST. |
| 75 | + // |
| 76 | + // Anyway, we set `true` for this because otherwise I've been seeing |
| 77 | + // `parse` throw an error: |
| 78 | + // |
| 79 | + // Error: Line 72: Invalid regular expression: missing / |
| 80 | + // |
| 81 | + // TODO: Debug and/or file an issue upstream. |
| 82 | + tokens: true, |
| 83 | + }); |
| 84 | + }, |
| 85 | + }, |
| 86 | +}; |
| 87 | + |
| 88 | +// Look at all files in possibleUIStringFilePaths, and collect all string |
| 89 | +// literals that might represent UI strings. |
| 90 | +const possibleUiStringLiterals = new Set(); |
| 91 | +possibleUIStringFilePaths.forEach(filePath => { |
| 92 | + const source = fs.readFileSync(filePath).toString(); |
| 93 | + const ast = parse(source, parseOptions); |
| 94 | + |
| 95 | + visit(ast, { |
| 96 | + // Find nodes with type "Literal" in the AST. |
| 97 | + /* eslint-disable no-shadow */ |
| 98 | + visitLiteral(path) { |
| 99 | + // To reduce false negatives, return false when `path` definitely |
| 100 | + // doesn't represent a string literal for a UI string in the app. |
| 101 | + |
| 102 | + const { value } = path.value; |
| 103 | + |
| 104 | + // Non-string literals: numbers, booleans, etc. |
| 105 | + if (typeof value !== 'string') { |
| 106 | + return false; |
| 107 | + } |
| 108 | + |
| 109 | + // String literals like 'react' in lines like |
| 110 | + // import React from 'react'; |
| 111 | + if (n.ImportDeclaration.check(path.parent.value)) { |
| 112 | + return false; |
| 113 | + } |
| 114 | + |
| 115 | + possibleUiStringLiterals.add(value); |
| 116 | + |
| 117 | + return this.traverse(path); |
| 118 | + }, |
| 119 | + }); |
| 120 | +}); |
| 121 | + |
| 122 | +// Check each key ("message ID" in formatjs's lingo) against |
| 123 | +// possibleUiStringLiterals, and make a list of any that aren't found. |
| 124 | +const danglingMessageIds = Object.keys(messages_en).filter( |
| 125 | + messageId => !possibleUiStringLiterals.has(messageId), |
| 126 | +); |
| 127 | + |
| 128 | +if (danglingMessageIds.length > 0) { |
| 129 | + console.warn( |
| 130 | + "Found message IDs in static/translations/messages_en.json that don't seem to be used in the app:", |
| 131 | + ); |
| 132 | + console.warn(danglingMessageIds); |
| 133 | +} |
0 commit comments