Merge pull request #181 from twilio/dev

Dev

Author: ktalebian

.github/ISSUE_TEMPLATE/bug_report.md

@@ -31,7 +31,7 @@ Please provide the steps to reproduce this bug:
 
 A clear and concise description of what you expected to happen.
 
-### Screenhots
+### Screenshots
 
 If applicable, add screenshots to help explain your problem.
 

.gitignore

@@ -71,3 +71,5 @@ plugin-test/
 package-lock.json
 
 .idea
+
+.lerna_backup

.prettierrc

@@ -1,7 +1,7 @@
 {
-    "useTabs": false,
-    "tabWidth": 4,
-    "semi": true,
-    "trailingComma": "es5",
-    "singleQuote": true
+  "useTabs": false,
+  "tabWidth": 2,
+  "semi": true,
+  "trailingComma": "es5",
+  "singleQuote": true
 }

.travis.yml

@@ -3,12 +3,16 @@ language: node_js
 node_js:
   - '8'
 
+before_install:
+  - sudo apt-get update
+  - sudo apt-get install -y libsecret-1-dev
+
 before_script:
   - npm install
 
 script:
   - npm run lint
-  - npm run test
+  - CI= npm run test
 
 after_success:
   - codecov --token="$CODECOV_TOKEN"

README.md

@@ -25,27 +25,22 @@
 
 ## Getting Started
 
----
-**NOTE**
-
-Flex plugin builder v3 is available in beta. Docs are available on the [dev branch](https://github.com/twilio/flex-plugin-builder/tree/dev). For more information please visit [Twilio Docs - Flex Plugin Builder](https://www.twilio.com/docs/flex/plugin-builder#plugin-builder-v3)
-
----
-
 This is a monorepo project managed by [lerna](https://github.com/lerna/lerna) for creating Twilio Flex plugins.
 
 - [create-flex-plugin](packages/create-flex-plugin): The CLI tool to start a new Flex plugin project
 - [flex-plugin](packages/flex-plugin): Runtime dependency for Flex plugins
+- [flex-plugin-scripts](packages/flex-plugin-scripts): The scripts used for building, testing, and deploying your plugin
 - [craco-config-flex-plugin](packages/craco-config-flex-plugin): Config override for [Create React App](https://github.com/facebook/create-react-app) using [craco](https://github.com/sharegate/craco)
 
 ## User Guide
 
 * [Creating a new plugin](packages/create-flex-plugin/README.md)
 * [Overriding configuration](packages/craco-config-flex-plugin/README.md)
+* [Available Scripts](packages/flex-plugin-scripts/README.md)
 
 ## Changelog
 
-Major changelogs can be found in the [changelog directory](/changelog/CHANGELOG.md).
+Major changelogs can be found in the [changelog directory](/changelog).
 
 ## Contributing
 

babel.config.js

@@ -3,4 +3,4 @@ module.exports = {
     "@babel/env",
     "@babel/typescript"
   ]
-}
+};

bin/docs-generator.js

@@ -0,0 +1,137 @@
+#!/usr/bin/env node
+
+const glob = require('glob');
+const fs = require('fs');
+const path = require('path');
+const pipe = require('@k88/pipe-compose').pipe;
+
+const inlineCommentsRegex = /<!--[\S\s]*-->/;
+const includeRegex = /docs-generator:include\(['"]?([\w\/.]*)['"]?\)/;
+const docStartRegex = /docs-generator:start/;
+const docEndRegex = /docs-generator:end/;
+
+const docStartComment = '<!-- docs-generator:start - Do not remove or modify this section -->';
+const docEndComment = '<!-- docs-generator:end - Do not remove or modify this section -->';
+
+const rootDir = path.dirname(__dirname);
+const pattern = `${rootDir}/packages/**/docs.config.js`;
+const packages = glob.sync(pattern, { ignore: '**/node_modules/**' });
+
+/**
+ * Validates the configuration format
+ *
+ * @param config
+ * @returns boolean
+ */
+const validateConfig = (config) => config.main && config.output;
+
+/**
+ * Flattens array
+ *
+ * @param arr
+ * @returns {*[]}
+ */
+const flatten = (arr) => [].concat.apply([], arr);
+
+/**
+ * Reads the file
+ *
+ * @param filePath    the file path
+ * @returns {string}  the file content
+ */
+const readFile = (filePath) => fs.readFileSync(filePath, 'utf8');
+
+/**
+ * Looks up for `<!-- docs-generator:include('/path') --!>` and includes the content
+ *
+ * @param dir
+ * @returns {function(*): *[]}
+ */
+const addInclude = (dir) => {
+  return lines => {
+    const newLines = lines.map(line => {
+      if (!inlineCommentsRegex.test(line)) {
+        return line;
+      }
+
+      const match = line.match(includeRegex);
+      if (!match || !match.length) {
+        return line;
+      }
+
+      const file = readFile(path.join(dir, match[1]));
+      const newLine = [
+        line,
+        docStartComment,
+        file.split('\n'),
+        docEndComment,
+      ];
+
+      return flatten(newLine);
+    });
+
+    return flatten(newLines);
+  }
+};
+
+/**
+ * Cleans up/removes all the auto-generated lines
+ * @param lines
+ * @returns {*}
+ */
+const cleanGeneratedLines = (lines) => {
+  const docStartLines = [];
+  const docEndLines = [];
+
+  lines.forEach((line, index) => {
+    if (!inlineCommentsRegex.test(line)) {
+      return;
+    }
+
+    if (docStartRegex.test(line)) {
+      docStartLines.push(index);
+    }
+
+    if (docEndRegex.test(line)) {
+      docEndLines.push(index);
+    }
+  });
+
+  if (docEndLines.length !== docStartLines.length) {
+    console.error('Found unmatched docs-generator blocks');
+    return lines;
+  }
+
+  while (docStartLines.length) {
+    const startIndex = docStartLines.pop();
+    const endIndex = docEndLines.pop();
+
+    lines.splice(startIndex, endIndex - startIndex + 1);
+  }
+
+  return lines;
+};
+
+/**
+ * Main script generator
+ * @param dir
+ */
+const generate = (dir) => {
+  const config = require(path.join(dir, 'docs.config.js'));
+  if (!validateConfig(config)) {
+    console.error('Configuration for %s is invalid', dir);
+    return;
+  }
+
+  const main = readFile(path.join(dir, config.main));
+  const output = path.join(dir, config.output);
+
+  const lines = main.split('\n');
+  const formattedLines = pipe(lines, cleanGeneratedLines, addInclude(dir));
+
+  fs.writeFileSync(output, formattedLines.join('\n'));
+};
+
+packages
+  .map(path.dirname)
+  .forEach(generate);

bin/publish

@@ -21,6 +21,7 @@ function run_script() {
 
 # Cleanup
 run_script $LERNA clean -y
+run_script $LERNA run clean
 run_script rm -rf node_modules
 
 # Install
@@ -35,7 +36,13 @@ run_script npm run build
 
 # Publish
 if [ "$1" == "public" ] ; then
+  echo -e "\n------------------------------------"
+  echo "-- Publishing as a public release --"
+  echo -e "------------------------------------\n"
   run_script $LERNA publish
 else
+  echo -e "\n-----------------------------------------"
+  echo "-- Publishing as a beta (next) release --"
+  echo -e "-----------------------------------------\n"
   run_script $LERNA publish --dist-tag next
 fi

changelog/CHANGELOG.md changelog/v2.mdchangelog/CHANGELOG.md renamed to changelog/v2.md

@@ -7,9 +7,11 @@ module.exports = {
   testEnvironment: 'jsdom',
   collectCoverageFrom: [
     '<rootDir>/packages/**/src/**/*.ts',
+    '!<rootDir>/packages/**/src/**/*.d.ts',
     '!<rootDir>/packages/**/src/**/*.test.ts',
     '!<rootDir>/packages/**/src/index.ts',
     '!<rootDir>/packages/**/templates/**/*.ts',
+    '!<rootDir>/packages/**/prints/**/*.ts',
   ],
   testMatch: [
     '<rootDir>/packages/**/*.test.ts'
@@ -22,5 +24,8 @@ module.exports = {
   ],
   coveragePathIgnorePatterns: [
     '/node_modules/',
+  ],
+  modulePathIgnorePatterns: [
+    '<rootDir>/packages/create-flex-plugin/templates/'
   ]
 };