Initial commit.

cubing · Sep 19, 2018 · 05528a8 · 05528a8
commit 05528a8
Show file tree

Hide file tree

Showing 31 changed files with 5,844 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+/node_modules
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,4 @@
+# Including this file prevents `npm`/`yarn` from excluding everything in
+# `.gitignore, and only ignores files specified here.
+/node_modules
+/dev-build
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,7 @@
+language: node_js
+node_js:
+  - "node"
+  - "lts/*"
+script:
+  - yarn install
+  # - make test
diff --git a/LICENSE.md b/LICENSE.md
diff --git a/README.md b/README.md
@@ -0,0 +1,34 @@
+# `cubing.js`
+
+A meta-library that makes it easy to use multiple
+[js.cubing.net](https://js.cubing.net) libraries.
+
+## Usage
+
+### Browser
+
+    <script src="cubing.js"></script>
+    <script>
+      const sune = alg.parse("R U R' U R U2 R'");
+      const antiSune = alg.invert(sune);
+      console.log(alg.algToString(antiSune));
+
+      const {KPuzzle, Puzzles} = kpuzzle;
+
+      const puzzle = new KPuzzle(Puzzles["333"]);
+      puzzle.applyMove("R");
+      console.log(puzzle.state);
+    </script>
+
+### Node / TypeScript
+
+    import {parse, invert, algToString} from "cubing/alg"
+    import {KPuzzle, Puzzles} from "cubing/kpuzzle"
+
+    const sune = parse("R U R' U R U2 R'");
+    const antiSune = invert(sune);
+    console.log(algToString(antiSune));
+
+    const puzzle = new KPuzzle(Puzzles["333"]);
+    puzzle.applyMove("R");
+    console.log(puzzle.state);
diff --git a/alg/index.d.ts b/alg/index.d.ts
@@ -0,0 +1 @@
+export * from "alg"
diff --git a/alg/index.js b/alg/index.js
@@ -0,0 +1 @@
+module.exports = require("alg");
diff --git a/alg/package.json b/alg/package.json
@@ -0,0 +1,4 @@
+{
+  "main": "./index.js",
+  "types": "./index.d.ts"
+}
diff --git a/browser-build/.gitignore b/browser-build/.gitignore
@@ -0,0 +1,2 @@
+/dist
+/yarn-error.log
diff --git a/browser-build/Makefile b/browser-build/Makefile
@@ -0,0 +1,21 @@
+NODE_BIN = ../node_modules/.bin
+
+.PHONY: dist
+dist: clean-dist
+	env PROD=true ${NODE_BIN}/webpack-cli
+
+.PHONY: dev
+dev:
+	${NODE_BIN}/webpack-cli --watch
+
+.PHONY: test
+test:
+	npm test
+
+.PHONY: clean
+clean: clean-dist
+	rm -f yarn-error.log
+
+.PHONY: clean-dist
+clean-dist:
+	rm -rf ./dist
diff --git a/browser-build/index.dist.d.ts b/browser-build/index.dist.d.ts
@@ -0,0 +1 @@
+../index.d.ts
diff --git a/browser-build/index.dist.js b/browser-build/index.dist.js
@@ -0,0 +1,6 @@
+module.exports.alg = require("expose-loader?alg!../alg");
+module.exports.kpuzzle = require("expose-loader?kpuzzle!../kpuzzle");
+module.exports.twisty = require("expose-loader?twisty!../twisty");
+module.exports.cuble = require("expose-loader?cuble!../cuble");
+module.exports["puzzle-geometry"] = require("expose-loader?puzzle-geometry!../puzzle-geometry");
+module.exports.puzzleGeometry = require("expose-loader?puzzleGeometry!../puzzle-geometry");
diff --git a/browser-build/test/html/index.html b/browser-build/test/html/index.html
@@ -0,0 +1,7 @@
+<html>
+  <title>cubing.js Test</title>
+  <script src="../../dist/cubing.js"></script>
+</style>
+<body>
+</body>
+</html>
diff --git a/browser-build/tsconfig.json b/browser-build/tsconfig.json
@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "moduleResolution": "node",
+    "target": "es6",
+
+    "rootDir": "src",
+    "outDir": "",
+    "declaration": true,
+    "sourceMap": true,
+
+    "alwaysStrict": true,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "strictNullChecks": true,
+    "noUnusedLocals": true
+  },
+  "include": [
+    "src",
+    "alg",
+    "kpuzzle"
+  ]
+}
diff --git a/browser-build/webpack.config.js b/browser-build/webpack.config.js
@@ -0,0 +1,69 @@
+const path = require("path");
+const webpack = require('webpack');
+const UglifyJSPlugin = require('uglifyjs-webpack-plugin');
+const WebpackNotifierPlugin = require("webpack-notifier");
+
+const umdName = "cubing";
+const externals = [];
+const targetFileName = "cubing.js";
+const targetDirName = "./dist";
+var PROD = JSON.parse(process.env.PROD || false);
+
+module.exports = {
+  entry: "./index.dist.js",
+  mode: "none",
+  devtool: "source-map",
+  plugins: [
+    new WebpackNotifierPlugin({
+      title: targetFileName,
+      alwaysNotify: true
+    })
+  ],
+  module: {
+    rules: [
+      {
+        loader: 'babel-loader',
+        options: {"presets": ["env"]}
+      },
+      {
+        test: /\.ts$/,
+        use: "ts-loader",
+        exclude: /node_modules/
+      }
+    ]
+  },
+  resolve: {
+    extensions: [ ".ts" ]
+  },
+  output: {
+    filename: targetFileName,
+    path: path.resolve(__dirname, targetDirName),
+    library: umdName,
+    libraryTarget: "umd",
+    // Workaround for Webpack 4. See https://github.com/webpack/webpack/issues/6522#issuecomment-371120689
+    globalObject: "typeof self !== \"undefined\" ? self : this"
+  },
+  externals: externals
+};
+
+if (PROD) {
+  // https://webpack.js.org/concepts/mode/#mode-production
+  module.exports.plugins.push(
+    new UglifyJSPlugin({
+      sourceMap: true,
+      uglifyOptions: {
+        mangle: false
+      }
+    })
+  );
+  module.exports.plugins.push(
+    new webpack.DefinePlugin({"process.env.NODE_ENV": JSON.stringify("production")})
+  );
+  module.exports.plugins.push(
+    new webpack.optimize.ModuleConcatenationPlugin()
+  );
+  module.exports.plugins.push(
+    new webpack.NoEmitOnErrorsPlugin()
+  );
+}
+