|
| 1 | +/** |
| 2 | + * CodeMirror JavaScript linter. |
| 3 | + * |
| 4 | + * @since 7.0.0 |
| 5 | + */ |
| 6 | + |
| 7 | +import CodeMirror from 'codemirror'; |
| 8 | + |
| 9 | +/** |
| 10 | + * CodeMirror Lint Error. |
| 11 | + * |
| 12 | + * @see https://codemirror.net/5/doc/manual.html#addon_lint |
| 13 | + * |
| 14 | + * @typedef {Object} CodeMirrorLintError |
| 15 | + * @property {string} message - Error message. |
| 16 | + * @property {'error'} severity - Severity. |
| 17 | + * @property {CodeMirror.Position} from - From position. |
| 18 | + * @property {CodeMirror.Position} to - To position. |
| 19 | + */ |
| 20 | + |
| 21 | +/** |
| 22 | + * JSHint options supported by Espree. |
| 23 | + * |
| 24 | + * @see https://jshint.com/docs/options/ |
| 25 | + * @see https://www.npmjs.com/package/espree#options |
| 26 | + * |
| 27 | + * @typedef {Object} SupportedJSHintOptions |
| 28 | + * @property {number} [esversion] - "This option is used to specify the ECMAScript version to which the code must adhere." |
| 29 | + * @property {boolean} [es5] - "This option enables syntax first defined in the ECMAScript 5.1 specification. This includes allowing reserved keywords as object properties." |
| 30 | + * @property {boolean} [es3] - "This option tells JSHint that your code needs to adhere to ECMAScript 3 specification. Use this option if you need your program to be executable in older browsers—such as Internet Explorer 6/7/8/9—and other legacy JavaScript environments." |
| 31 | + * @property {boolean} [module] - "This option informs JSHint that the input code describes an ECMAScript 6 module. All module code is interpreted as strict mode code." |
| 32 | + * @property {'implied'} [strict] - "This option requires the code to run in ECMAScript 5's strict mode." |
| 33 | + */ |
| 34 | + |
| 35 | +/** |
| 36 | + * Validates JavaScript. |
| 37 | + * |
| 38 | + * @since 7.0.0 |
| 39 | + * |
| 40 | + * @param {string} text - Source. |
| 41 | + * @param {SupportedJSHintOptions} options - Linting options. |
| 42 | + * @returns {Promise<CodeMirrorLintError[]>} |
| 43 | + */ |
| 44 | +async function validator( text, options ) { |
| 45 | + const errors = /** @type {CodeMirrorLintError[]} */ []; |
| 46 | + try { |
| 47 | + const espree = await import( /* webpackIgnore: true */ 'espree' ); |
| 48 | + espree.parse( text, { |
| 49 | + ...getEspreeOptions( options ), |
| 50 | + loc: true, |
| 51 | + } ); |
| 52 | + } catch ( error ) { |
| 53 | + if ( |
| 54 | + // This is an `EnhancedSyntaxError` in Espree: <https://github.com/brettz9/espree/blob/3c1120280b24f4a5e4c3125305b072fa0dfca22b/packages/espree/lib/espree.js#L48-L54>. |
| 55 | + error instanceof SyntaxError && |
| 56 | + typeof error.lineNumber === 'number' && |
| 57 | + typeof error.column === 'number' |
| 58 | + ) { |
| 59 | + const line = error.lineNumber - 1; |
| 60 | + errors.push( { |
| 61 | + message: error.message, |
| 62 | + severity: 'error', |
| 63 | + from: CodeMirror.Pos( line, error.column - 1 ), |
| 64 | + to: CodeMirror.Pos( line, error.column ), |
| 65 | + } ); |
| 66 | + } else { |
| 67 | + console.warn( '[CodeMirror] Unable to lint JavaScript:', error ); // jshint ignore:line |
| 68 | + } |
| 69 | + } |
| 70 | + |
| 71 | + return errors; |
| 72 | +} |
| 73 | + |
| 74 | +CodeMirror.registerHelper( 'lint', 'javascript', validator ); |
| 75 | + |
| 76 | +/** |
| 77 | + * Gets the options for Espree from the supported JSHint options. |
| 78 | + * |
| 79 | + * @since 7.0.0 |
| 80 | + * |
| 81 | + * @param {SupportedJSHintOptions} options - Linting options for JSHint. |
| 82 | + * @return {{ |
| 83 | + * ecmaVersion?: number|'latest', |
| 84 | + * ecmaFeatures?: { |
| 85 | + * impliedStrict?: true |
| 86 | + * } |
| 87 | + * }} |
| 88 | + */ |
| 89 | +function getEspreeOptions( options ) { |
| 90 | + const ecmaFeatures = {}; |
| 91 | + if ( options.strict === 'implied' ) { |
| 92 | + ecmaFeatures.impliedStrict = true; |
| 93 | + } |
| 94 | + |
| 95 | + return { |
| 96 | + ecmaVersion: getEcmaVersion( options ), |
| 97 | + sourceType: options.module ? 'module' : 'script', |
| 98 | + ecmaFeatures, |
| 99 | + }; |
| 100 | +} |
| 101 | + |
| 102 | +/** |
| 103 | + * Gets the ECMAScript version. |
| 104 | + * |
| 105 | + * @since 7.0.0 |
| 106 | + * |
| 107 | + * @param {SupportedJSHintOptions} options - Options. |
| 108 | + * @return {number|'latest'} ECMAScript version. |
| 109 | + */ |
| 110 | +function getEcmaVersion( options ) { |
| 111 | + if ( typeof options.esversion === 'number' ) { |
| 112 | + return options.esversion; |
| 113 | + } |
| 114 | + if ( options.es5 ) { |
| 115 | + return 5; |
| 116 | + } |
| 117 | + if ( options.es3 ) { |
| 118 | + return 3; |
| 119 | + } |
| 120 | + return 'latest'; |
| 121 | +} |
0 commit comments