@ebay/skin 16.0.0 → 16.1.0-0

package/scripts/develop-module_proper/code-generators/style-generator.js

@@ -1,8 +1,8 @@
-const fs = require('fs');
-const path = require('path');
-const log = require('../../log');
-const BaseGenerator = require('./base-generator');
-const writeLine = require('../util/line-writer');
+const fs = require("fs");
+const path = require("path");
+const log = require("../../log");
+const BaseGenerator = require("./base-generator");
+const writeLine = require("../util/line-writer");
 
 const getBaseStyleContent = (
     moduleId
@@ -11,7 +11,8 @@ const getBaseStyleContent = (
     display: block;
 }
 `;
-const getReferBaseStyleContent = (moduleId) => `@import '../base/${moduleId}.less';\n`;
+const getReferBaseStyleContent = (moduleId) =>
+    `@import '../base/${moduleId}.less';\n`;
 const getModuleBrowserContent = (moduleId) => `{
     "dependencies": [
         "require: ./${moduleId}"
@@ -30,7 +31,14 @@ class StyleGenerator extends BaseGenerator {
      */
     constructor(moduleName, moduleId) {
         super(moduleName, moduleId);
-        this.sourceStyleLocation = path.join(__dirname, '..', '..', '..', 'src', 'less');
+        this.sourceStyleLocation = path.join(
+            __dirname,
+            "..",
+            "..",
+            "..",
+            "src",
+            "less"
+        );
     }
 
     generate() {
@@ -38,11 +46,17 @@ class StyleGenerator extends BaseGenerator {
         this._addSourceBundleStyles();
         this._addPackagingStyles();
 
-        log.info('Styles added! Make changes in %s folder.', path.join(this.sourceModuleLocation));
+        log.info(
+            "Styles added! Make changes in %s folder.",
+            path.join(this.sourceModuleLocation)
+        );
     }
 
     _addSourceStyles() {
-        const sourceModuleLocation = path.join(this.sourceStyleLocation, this.moduleId);
+        const sourceModuleLocation = path.join(
+            this.sourceStyleLocation,
+            this.moduleId
+        );
 
         if (!fs.existsSync(sourceModuleLocation)) {
             fs.mkdirSync(sourceModuleLocation);
@@ -51,9 +65,18 @@ class StyleGenerator extends BaseGenerator {
         const baseStyleContent = getBaseStyleContent(this.moduleId);
         const dsContent = getReferBaseStyleContent(this.moduleId);
 
-        this._addSourceStylesProper(path.join(sourceModuleLocation, 'base'), baseStyleContent);
-        this._addSourceStylesProper(path.join(sourceModuleLocation, 'ds4'), dsContent);
-        this._addSourceStylesProper(path.join(sourceModuleLocation, 'ds6'), dsContent);
+        this._addSourceStylesProper(
+            path.join(sourceModuleLocation, "base"),
+            baseStyleContent
+        );
+        this._addSourceStylesProper(
+            path.join(sourceModuleLocation, "ds4"),
+            dsContent
+        );
+        this._addSourceStylesProper(
+            path.join(sourceModuleLocation, "ds6"),
+            dsContent
+        );
 
         this.sourceModuleLocation = sourceModuleLocation;
     }
@@ -71,12 +94,19 @@ class StyleGenerator extends BaseGenerator {
     }
 
     _addSourceBundleStyles() {
-        this._addSourceBundleStylesProper('ds4');
-        this._addSourceBundleStylesProper('ds6');
+        this._addSourceBundleStylesProper("ds4");
+        this._addSourceBundleStylesProper("ds6");
     }
 
     _addSourceBundleStylesProper(version) {
-        const filePathFromRoot = path.join('src', 'less', 'bundles', 'skin', version, 'skin.less');
+        const filePathFromRoot = path.join(
+            "src",
+            "less",
+            "bundles",
+            "skin",
+            version,
+            "skin.less"
+        );
         const newLineContent = `@import "../../../${this.moduleId}/${version}/${this.moduleId}.less";`;
         writeLine({
             filePathFromRoot,
@@ -91,25 +121,34 @@ class StyleGenerator extends BaseGenerator {
         this._addPackagingIndexDependencies();
         this._addPackagingBrowserDependencies();
         this._addPackagingModuleBrowserDependencies();
-        this._addPackagingStylesDsReference('ds4');
-        this._addPackagingStylesDsReference('ds6');
+        this._addPackagingStylesDsReference("ds4");
+        this._addPackagingStylesDsReference("ds6");
         this._addPackagingStylesIndexReference();
     }
 
     _addPackagingIndexDependencies() {
-        this._addDependencies(`        "require: ./${this.moduleId}"`, 'index.browser.json');
+        this._addDependencies(
+            `        "require: ./${this.moduleId}"`,
+            "index.browser.json"
+        );
     }
 
     _addPackagingBrowserDependencies() {
-        this._addDependencies(`    "./${this.moduleId}"`, 'browser.json');
+        this._addDependencies(`    "./${this.moduleId}"`, "browser.json");
 
         const from = `./dist/${this.moduleId}/ds6/${this.moduleId}.css`;
         const newMappingItem = {
             from,
             to: `./dist/${this.moduleId}/ds4/${this.moduleId}.css`,
-            'if-flag': 'ds-4',
+            "if-flag": "ds-4",
         };
-        const browserJsonFile = path.join(__dirname, '..', '..', '..', 'browser.json');
+        const browserJsonFile = path.join(
+            __dirname,
+            "..",
+            "..",
+            "..",
+            "browser.json"
+        );
         const newMappings = [];
         const browserJson = require(browserJsonFile);
         let newItemAdded = false;
@@ -132,36 +171,49 @@ class StyleGenerator extends BaseGenerator {
     }
 
     _addPackagingModuleBrowserDependencies() {
-        const projectRootPath = path.join(__dirname, '..', '..', '..');
-        const moduleBrowserPath = path.join(projectRootPath, `${this.moduleId}.browser.json`);
+        const projectRootPath = path.join(__dirname, "..", "..", "..");
+        const moduleBrowserPath = path.join(
+            projectRootPath,
+            `${this.moduleId}.browser.json`
+        );
 
         if (fs.existsSync(moduleBrowserPath)) {
-            log.warn('[STYLES][%s] Module browser content already exists!', moduleBrowserPath);
+            log.warn(
+                "[STYLES][%s] Module browser content already exists!",
+                moduleBrowserPath
+            );
             return;
         }
 
-        fs.writeFileSync(moduleBrowserPath, getModuleBrowserContent(this.moduleId));
+        fs.writeFileSync(
+            moduleBrowserPath,
+            getModuleBrowserContent(this.moduleId)
+        );
     }
 
     _addDependencies(newLineContent, filePathFromRoot) {
         writeLine({
             filePathFromRoot,
-            sectionPredicate: (line) => line.match(/"dependencies"\s*\t*:\s*\t*\[/),
+            sectionPredicate: (line) =>
+                line.match(/"dependencies"\s*\t*:\s*\t*\[/),
             newLineContent,
             getLineMeta: (prevLine, currentLine, nextLine) => ({
                 shouldAppend:
                     (nextLine && nextLine.match(/]/)) ||
-                    (!StyleGenerator._isLegacyLine(currentLine) && currentLine > newLineContent),
-                prevLineSuffix: prevLine && !prevLine.endsWith(',') ? ',' : '',
-                newLineSuffix: !nextLine || nextLine.match(/]/) ? '' : ',',
+                    (!StyleGenerator._isLegacyLine(currentLine) &&
+                        currentLine > newLineContent),
+                prevLineSuffix: prevLine && !prevLine.endsWith(",") ? "," : "",
+                newLineSuffix: !nextLine || nextLine.match(/]/) ? "" : ",",
             }),
         });
     }
 
     _addPackagingStylesDsReference(version) {
-        const filePathFromRoot = `${this.moduleId}${version === 'ds4' ? '[ds-4]' : ''}.js`;
+        const filePathFromRoot = `${this.moduleId}${
+            version === "ds4" ? "[ds-4]" : ""
+        }.js`;
         if (fs.existsSync(filePathFromRoot)) {
-            log.warn('[STYLES][%s] Style already exists!', filePathFromRoot);
+            log.warn("[STYLES][%s] Style already exists!", filePathFromRoot);
             return;
         }
         fs.writeFileSync(
@@ -171,7 +223,7 @@ class StyleGenerator extends BaseGenerator {
     }
 
     _addPackagingStylesIndexReference() {
-        const filePathFromRoot = 'index.js';
+        const filePathFromRoot = "index.js";
         const newLineContent = `import './${this.moduleId}';`;
         writeLine({
             filePathFromRoot,
@@ -179,14 +231,17 @@ class StyleGenerator extends BaseGenerator {
             getLineMeta: (prevLine, currentLine, nextLine) => ({
                 shouldAppend:
                     !nextLine ||
-                    (!StyleGenerator._isLegacyLine(currentLine) && currentLine > newLineContent),
+                    (!StyleGenerator._isLegacyLine(currentLine) &&
+                        currentLine > newLineContent),
             }),
         });
     }
 
     static _isLegacyLine(currentLine) {
         return (
-            currentLine.match(/global/) || currentLine.match(/utility/) || currentLine.match(/root/)
+            currentLine.match(/global/) ||
+            currentLine.match(/utility/) ||
+            currentLine.match(/root/)
         );
     }
 }

package/scripts/develop-module_proper/code-generators/test-generator.js

@@ -1,7 +1,7 @@
-const fs = require('fs');
-const path = require('path');
-const log = require('../../log');
-const BaseGenerator = require('./base-generator');
+const fs = require("fs");
+const path = require("path");
+const log = require("../../log");
+const BaseGenerator = require("./base-generator");
 
 const getStorybookTestContent = (moduleName, moduleId) => `// Generated test
 export default { title: '${moduleName}' };
@@ -27,25 +27,31 @@ class TestGenerator extends BaseGenerator {
     generate() {
         this._addStoryBookTests();
 
-        log.info('Tests added! Make changes in %s file.', path.join(this.storybookTestFilePath));
+        log.info(
+            "Tests added! Make changes in %s file.",
+            path.join(this.storybookTestFilePath)
+        );
     }
 
     _addStoryBookTests() {
         const testFilePath = path.join(
             __dirname,
-            '..',
-            '..',
-            '..',
-            'src',
-            'less',
+            "..",
+            "..",
+            "..",
+            "src",
+            "less",
             this.moduleId,
             `${this.moduleId}.stories.js`
         );
         if (fs.existsSync(testFilePath)) {
-            log.warn('[TESTS][%s] Test file already exists!', testFilePath);
+            log.warn("[TESTS][%s] Test file already exists!", testFilePath);
             return;
         }
-        fs.writeFileSync(testFilePath, getStorybookTestContent(this.moduleName, this.moduleId));
+        fs.writeFileSync(
+            testFilePath,
+            getStorybookTestContent(this.moduleName, this.moduleId)
+        );
         this.storybookTestFilePath = testFilePath;
     }
 }

package/scripts/develop-module_proper/errors/illegal-input.js

@@ -1,4 +1,4 @@
-const BaseError = require('./base-error');
+const BaseError = require("./base-error");
 
 class IllegalInputError extends BaseError {
     constructor(message) {

package/scripts/develop-module_proper/index.js

@@ -1,13 +1,13 @@
-const inputParser = require('./input/parse-input');
-const titleCase = require('./util/title-case');
-const StyleGenerator = require('./code-generators/style-generator');
-const DocumentationGenerator = require('./code-generators/doc-generator');
-const TestGenerator = require('./code-generators/test-generator');
+const inputParser = require("./input/parse-input");
+const titleCase = require("./util/title-case");
+const StyleGenerator = require("./code-generators/style-generator");
+const DocumentationGenerator = require("./code-generators/doc-generator");
+const TestGenerator = require("./code-generators/test-generator");
 
 class DevelopModule {
     constructor() {
         this.moduleName = titleCase(inputParser.parse().value);
-        this.moduleId = this.moduleName.replace(/\s/g, '-').toLowerCase();
+        this.moduleId = this.moduleName.replace(/\s/g, "-").toLowerCase();
     }
 
     run() {

package/scripts/develop-module_proper/input/module-name.js

@@ -1,6 +1,6 @@
-const IllegalInputError = require('../errors/illegal-input');
+const IllegalInputError = require("../errors/illegal-input");
 
-const VALUE = Symbol('value');
+const VALUE = Symbol("value");
 
 /**
  * This is a value object for module name.
@@ -28,21 +28,23 @@ class ModuleName {
      * Do not invoke this as the user inputs are immutable!
      */
     set value(newMoudleName) {
-        throw new Error('Module name provided by user is immutable!');
+        throw new Error("Module name provided by user is immutable!");
     }
 }
 
 function _validate(moduleName) {
     if (!moduleName) {
-        throw new IllegalInputError('Module name has to be provided!');
+        throw new IllegalInputError("Module name has to be provided!");
     }
 
-    if (typeof moduleName !== 'string') {
-        throw new IllegalInputError('Module name has to be string!');
+    if (typeof moduleName !== "string") {
+        throw new IllegalInputError("Module name has to be string!");
     }
 
     if (moduleName.trim().length < 2) {
-        throw new IllegalInputError('Module name has to be atleast 2 character long!');
+        throw new IllegalInputError(
+            "Module name has to be atleast 2 character long!"
+        );
     }
 }
 

package/scripts/develop-module_proper/input/parse-input.js

@@ -1,12 +1,14 @@
-const yargs = require('yargs');
-const ModuleName = require('./module-name');
+const yargs = require("yargs");
+const ModuleName = require("./module-name");
 
-const argv = yargs.usage('scripts/develop-module <option> [option value]').option('m', {
-    alias: 'moduleName',
-    demandOption: true,
-    description: 'The new module name that you want to develop',
-    type: 'string',
-}).argv;
+const argv = yargs
+    .usage("scripts/develop-module <option> [option value]")
+    .option("m", {
+        alias: "moduleName",
+        demandOption: true,
+        description: "The new module name that you want to develop",
+        type: "string",
+    }).argv;
 
 module.exports = {
     /**

package/scripts/develop-module_proper/util/line-writer.js

@@ -1,6 +1,6 @@
-const fs = require('fs');
-const path = require('path');
-const log = require('../../log');
+const fs = require("fs");
+const path = require("path");
+const log = require("../../log");
 
 /**
  * Write a line to an existing file.
@@ -20,47 +20,60 @@ function writeLine(options) {
         getLineMeta,
     } = options;
 
-    const filePath = path.join(__dirname, '..', '..', '..', filePathFromRoot);
+    const filePath = path.join(__dirname, "..", "..", "..", filePathFromRoot);
     if (!fs.existsSync(filePath)) {
-        log.warn('%s file does not exist to append to!', filePath);
+        log.warn("%s file does not exist to append to!", filePath);
     }
 
     let isSectionMatched = false;
     let lineAppended = false;
     const newFileContents = [];
-    const currentFileContent = fs.readFileSync(filePath, 'utf8');
-    const currentFileContents = currentFileContent.split('\n');
+    const currentFileContent = fs.readFileSync(filePath, "utf8");
+    const currentFileContents = currentFileContent.split("\n");
     for (let i = 0; i < currentFileContents.length; i++) {
         const line = currentFileContents[i];
         if (line.match(duplicateCheckText || newLineContent)) {
-            log.warn('[%s] File already has line appended!', filePath);
+            log.warn("[%s] File already has line appended!", filePath);
             return;
         }
         if (
             !isSectionMatched &&
-            (typeof sectionPredicate !== 'function' || sectionPredicate(line))
+            (typeof sectionPredicate !== "function" || sectionPredicate(line))
         ) {
             isSectionMatched = true;
         } else if (isSectionMatched && !lineAppended) {
             const prevLine = i > 0 ? currentFileContents[i - 1] : null;
-            const nextLine = i < currentFileContents.length ? currentFileContents[i + 1] : null;
-            const { prevLineSuffix, newLineSuffix = '', shouldAppend = false } = getLineMeta(
-                prevLine,
-                line,
-                nextLine
-            );
+            const nextLine =
+                i < currentFileContents.length
+                    ? currentFileContents[i + 1]
+                    : null;
+            const {
+                prevLineSuffix,
+                newLineSuffix = "",
+                shouldAppend = false,
+            } = getLineMeta(prevLine, line, nextLine);
             if (shouldAppend) {
-                _processUpdates(newFileContents, newLineContent, prevLineSuffix, newLineSuffix);
+                _processUpdates(
+                    newFileContents,
+                    newLineContent,
+                    prevLineSuffix,
+                    newLineSuffix
+                );
                 lineAppended = true;
             }
         }
         newFileContents.push(line);
     }
 
-    fs.writeFileSync(filePath, newFileContents.join('\n'));
+    fs.writeFileSync(filePath, newFileContents.join("\n"));
 }
 
-function _processUpdates(newFileContents, newLineContent, prevLineSuffix, newLineSuffix) {
+function _processUpdates(
+    newFileContents,
+    newLineContent,
+    prevLineSuffix,
+    newLineSuffix
+) {
     if (prevLineSuffix) {
         newFileContents.push(newFileContents.pop() + prevLineSuffix);
     }

package/scripts/develop-module_proper/util/title-case.js

@@ -1,11 +1,12 @@
 function titleCase(str) {
-    const splitStr = str.toLowerCase().split(' ');
+    const splitStr = str.toLowerCase().split(" ");
 
     for (let i = 0; i < splitStr.length; i++) {
-        splitStr[i] = splitStr[i].charAt(0).toUpperCase() + splitStr[i].substring(1);
+        splitStr[i] =
+            splitStr[i].charAt(0).toUpperCase() + splitStr[i].substring(1);
     }
 
-    return splitStr.join(' ');
+    return splitStr.join(" ");
 }
 
 module.exports = titleCase;