Add code validator and Travis CI

64json · 64json · commit e7dee5cc51c1 · 2019-06-14T03:27:58.000+09:00
diff --git a/.bin/batchFix.js b/.bin/batchFix.js
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,4 @@
 /.idea
 /node_modules
 /npm-debug.log
-/package.json
-/package-lock.json
 .DS_Store
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,3 @@
+language: node_js
+node_js: 'stable'
+cache: npm
diff --git a/.validate/constants.js b/.validate/constants.js
@@ -0,0 +1,9 @@
+const path = require('path');
+
+const rootDir = path.resolve(__dirname, '..');
+const MAX_STEPS = 100;
+
+module.exports = {
+  rootDir,
+  MAX_STEPS,
+};
diff --git a/.validate/index.js b/.validate/index.js
@@ -0,0 +1,32 @@
+const path = require('path');
+const fs = require('fs-extra');
+
+const { listDirectories, listFiles } = require('./utils');
+const { rootDir } = require('./constants');
+const validate = {
+  js: require('./js'),
+};
+
+const categories = listDirectories(rootDir).filter(dir => dir !== 'node_modules');
+let hasError = false;
+for (const category of categories) {
+  const categoryDir = path.resolve(rootDir, category);
+  const algorithms = listDirectories(categoryDir);
+  for (const algorithm of algorithms) {
+    const algorithmDir = path.resolve(categoryDir, algorithm);
+    const files = listFiles(algorithmDir);
+    for (const file of files) {
+      const ext = file.split('.').pop();
+      const validator = validate[ext];
+      if (validator) {
+        const filePath = path.resolve(algorithmDir, file);
+        const content = fs.readFileSync(filePath, 'utf-8');
+        if (!validator(category, algorithm, file, content)) {
+          hasError = true;
+        }
+      }
+    }
+  }
+}
+
+process.exit(hasError ? 1 : 0);
diff --git a/.validate/js/index.js b/.validate/js/index.js
@@ -0,0 +1,40 @@
+const path = require('path');
+const { Commander } = require('algorithm-visualizer');
+const { rootDir } = require('../constants');
+const { signale } = require('../utils');
+const { MAX_STEPS } = require('../constants');
+
+module.exports = (category, algorithm, file, content) => {
+  const errors = [];
+  const error = message => errors.push(message);
+  const warns = [];
+  const warn = message => warns.push(message);
+
+  try {
+    Commander.init();
+    require(path.resolve(rootDir, category, algorithm, file));
+  } catch (e) {
+    error(e);
+  }
+  const steps = Commander.commands.filter(command => command.method === 'delay').length;
+  if (steps > MAX_STEPS) {
+    warn('Too many steps.');
+  }
+  if (!/\/\/ import visualization libraries {/.test(content)) {
+    error('Missing the code folding for importing visualization libraries.');
+  }
+  if (!/\/\/ define tracer variables {/.test(content)) {
+    error('Missing the code folding for defining tracer variables.');
+  }
+  if (!/\/\/ visualize {/.test(content)) {
+    error('Missing the code folding for visualizing.');
+  }
+
+  if (errors.length || warns.length) {
+    signale.log(`${category}/${algorithm}/${file}`);
+    warns.forEach(error => signale.warn(error));
+    errors.forEach(error => signale.error(error));
+    signale.log();
+  }
+  return errors.length === 0;
+};
diff --git a/.validate/utils.js b/.validate/utils.js
@@ -0,0 +1,24 @@
+const path = require('path');
+const fs = require('fs-extra');
+const { Signale } = require('signale');
+
+function isDirectory(dirPath) {
+  return fs.lstatSync(dirPath).isDirectory();
+}
+
+function listFiles(dirPath) {
+  return fs.pathExistsSync(dirPath) ? fs.readdirSync(dirPath).filter(fileName => !fileName.startsWith('.')) : [];
+}
+
+function listDirectories(dirPath) {
+  return listFiles(dirPath).filter(fileName => isDirectory(path.resolve(dirPath, fileName)));
+}
+
+const signale = new Signale();
+
+module.exports = {
+  isDirectory,
+  listFiles,
+  listDirectories,
+  signale,
+};
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Algorithms
+# Algorithms [![Travis (.com)](https://img.shields.io/travis/com/algorithm-visualizer/algorithms.svg?style=flat-square)](https://travis-ci.com/algorithm-visualizer/algorithms)
 
 > This repository is part of the project [Algorithm Visualizer](https://github.com/algorithm-visualizer).
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+language: node_js`
	`2`	`+node_js: 'stable'`
	`3`	`+cache: npm`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Algorithms`
	`1`	`+# Algorithms [![Travis (.com)](https://img.shields.io/travis/com/algorithm-visualizer/algorithms.svg?style=flat-square)](https://travis-ci.com/algorithm-visualizer/algorithms)`
`2`	`2`
`3`	`3`	`> This repository is part of the project [Algorithm Visualizer](https://github.com/algorithm-visualizer).`
`4`	`4`