Merge pull request mahirshah#8 from css-blocks/js-gen-updates

JS Grammar Updates

Author: mahirshah

package-lock.json

@@ -12,7 +12,11 @@
     "lint": "node node_modules/eslint/bin/eslint.js src/",
     "precommit-msg": "echo 'Pre-commit checks...' && exit 0"
   },
-  "pre-commit": [ "precommit-msg", "lint", "test"],
+  "pre-commit": [
+    "precommit-msg",
+    "lint",
+    "test"
+  ],
   "author": "mahirshah",
   "license": "ISC",
   "types": "css-property-parser.d.ts",
@@ -35,6 +39,6 @@
     "fs-extra": "^3.0.1",
     "mdn-data": "1.0.0",
     "moo": "^0.4.1",
-    "nearley": "^2.10.3"
+    "nearley": "^2.11.0"
   }
 }

package.json

@@ -1,10 +1,12 @@
+const path = require('path');
+
 module.exports = {
-  JSON_GRAMMAR_PATH: `${__dirname}/../grammars/json/`,
-  NEARLEY_PROPERTY_GRAMMAR_PATH: `${__dirname}/../grammars/nearley/properties/`,
-  GENERATED_JSON_GRAMMAR_PATH: `${__dirname}/../grammars/generated/json/`,
-  GENERATED_NEARLEY_GRAMMAR_PATH: `${__dirname}/../grammars/generated/nearley/`,
-  GENERATED_JS_GRAMMAR_PATH: `${__dirname}/../grammars/generated/js/`,
-  FORMATTED_DATA_PATH: `${__dirname}/../../formatted-data/`,
-  FORMAL_SYNTAX_GRAMMAR_PATH: `${__dirname}/../grammars/`,
-  NEARLEY_BIN_ROOT: `${__dirname}/../../node_modules/nearley/bin/`,
+  JSON_GRAMMAR_PATH: path.join(__dirname, '/../grammars/json/'),
+  NEARLEY_PROPERTY_GRAMMAR_PATH: path.join(__dirname, '/../grammars/nearley/properties/'),
+  GENERATED_JSON_GRAMMAR_PATH: path.join(__dirname, '/../grammars/generated/json/'),
+  GENERATED_NEARLEY_GRAMMAR_PATH: path.join(__dirname, '/../grammars/generated/nearley/'),
+  GENERATED_JS_GRAMMAR_PATH: path.join(__dirname, '/../grammars/generated/js/'),
+  FORMATTED_DATA_PATH: path.join(__dirname, '/../../formatted-data/'),
+  FORMAL_SYNTAX_GRAMMAR_PATH: path.join(__dirname, '/../grammars/'),
+  NEARLEY_BIN_ROOT: path.join(__dirname, '/../../node_modules/nearley/bin/'),
 };

src/constants/paths.js

@@ -6,7 +6,6 @@ const shorthandProperties = require('../formatted-data/shorthand-properties.json
 const CSS_CONSTANTS = require('./constants/css');
 const { CLASSIFICATIONS } = require('./constants/shorthandProperties');
 const LocationIndexTracker = require('./utils/LocationIndexTracker');
-const PATHS = require('./constants/paths');
 const { ParseError, UnsupportedPropertyError, UnknownPropertyError } = require('./errors');
 const SHORTHAND_IDENT_TO_LONGHAND_PROPERTY_MAP = require('./constants/shorthandIdentToLonghandPropertyMap.json');
 const {
@@ -89,8 +88,7 @@ module.exports = function expandShorthandProperty(propertyName,
   }
 
   // get the compiled grammar file for this property
-  // eslint-disable-next-line import/no-dynamic-require
-  const grammar = require(`${PATHS.GENERATED_JS_GRAMMAR_PATH}${propertyName}`);
+  const grammar = require('./grammars/generated')[propertyName];
   // remove any block style comments and extra whitespace
   const formattedPropertyValue = propertyValue.replace(R_BLOCK_COMMENT, ' ').replace(/\s+/g, ' ').trim();
   let parser;

src/expandShorthandProperty.js

@@ -1,3 +1,3 @@
 [
-  ["Base", "%hexColor"]
-]
+  ["Base", "%color"]
+]

src/grammars/json/hex-color.json

@@ -1,6 +1,6 @@
 const nearley = require('nearley');
 const { css: { properties } } = require('mdn-data');
-const { PATHS, CSS } = require('./constants');
+const { CSS } = require('./constants');
 
 /**
  * Checks if the given property, value pair is valid.
@@ -16,8 +16,7 @@ module.exports = function isValidDeclaration(property, value) {
     return true;
   }
 
-  // eslint-disable-next-line import/no-dynamic-require
-  const propertyGrammar = require(`${PATHS.GENERATED_JS_GRAMMAR_PATH}${property}.js`);
+  const propertyGrammar = require('./grammars/generated')[property];
 
   try {
     const parser = new nearley.Parser(nearley.Grammar.fromCompiled(propertyGrammar)).feed(value);

src/isValidDeclaration.js

@@ -2,6 +2,7 @@
  * Format each JSON grammar into a Nearley grammar
  */
 const fs = require('fs-extra');
+const path = require('path');
 const NearleyGrammarFormatter = require('../formatters/grammarFormatters/NearleyGrammarFormatter');
 const PATHS = require('../constants/paths');
 const GRAMMAR_CONSTANTS = require('../constants/grammars');
@@ -58,17 +59,26 @@ const compilationQueue = async.queue((task, callback) => {
   console.log(task);
   exec(task, callback);
 }, MAX_PARALLEL_PROCESSES);
+
+const jsModules = [];
 const compilationCommands = fs.readdirSync(PATHS.GENERATED_NEARLEY_GRAMMAR_PATH)
   .map((fileName) => {
+    const propName = fileName.replace(`.${GRAMMAR_CONSTANTS.GRAMMAR_FILE_EXTENSION}`, '');
+    const jsFileName = `${propName}.${JAVASCRIPT_FILE_EXTENSION}`;
     const nearleyFilePath = JSON.stringify(`${PATHS.GENERATED_NEARLEY_GRAMMAR_PATH}${fileName}`);
     const jsFilePath = JSON.stringify(
-      `${PATHS.GENERATED_JS_GRAMMAR_PATH}${fileName.replace(`.${GRAMMAR_CONSTANTS.GRAMMAR_FILE_EXTENSION}`,
-        `.${JAVASCRIPT_FILE_EXTENSION}`)}`
+      path.join(PATHS.GENERATED_JS_GRAMMAR_PATH, jsFileName)
     );
 
+    jsModules.push(`  '${propName}': require('./js/${jsFileName}')`);
+
     return `node ${PATHS.NEARLEY_BIN_ROOT}${NEARLEY_COMPILER_FILE_NAME} ${nearleyFilePath} > ${jsFilePath}`;
   });
 
+const jsExportsFile = `module.exports = {\n${jsModules.join(',\n')}\n}`;
+
+fs.writeFileSync(path.join(PATHS.GENERATED_JS_GRAMMAR_PATH, '../index.js'), jsExportsFile);
+
 compilationQueue.push(compilationCommands, (err) => {
   if (err) {
     console.error(err);

src/scripts/formatGrammars.js

@@ -1,15 +1,13 @@
 const { assert } = require('chai');
 const nearley = require('nearley');
-const { PATHS } = require('../src/constants');
-
 
 /**
  * Tests for {@link isValidDeclaration}
  */
 describe('baseGrammars', function () {
   // TODO: add support for scientific notation
   describe('number', function () {
-    const propertyGrammar = require(`${PATHS.GENERATED_JS_GRAMMAR_PATH}number.js`);
+    const propertyGrammar = require('../src/grammars/generated').number;
 
     [
       '1',
@@ -34,7 +32,7 @@ describe('baseGrammars', function () {
   });
 
   describe('length', function () {
-    const propertyGrammar = require(`${PATHS.GENERATED_JS_GRAMMAR_PATH}length.js`);
+    const propertyGrammar = require('../src/grammars/generated').length;
 
     [
       '1px',