Support asconfig.json

.gitignore

@@ -6,3 +6,4 @@ out/
 raw/
 .history
 *.backup
+.vscode

bin/asinit

@@ -42,6 +42,7 @@ const compilerDir = path.join(__dirname, "..");
 const compilerVersion = require(path.join(compilerDir, "package.json")).version;
 const assemblyDir = path.join(projectDir, "assembly");
 const tsconfigFile = path.join(assemblyDir, "tsconfig.json");
+const asconfigFile = path.join(projectDir, "asconfig.json");
 let tsconfigBase = path.relative(assemblyDir, path.join(compilerDir, "std", "assembly.json"));
 if (/^(\.\.[/\\])*node_modules[/\\]assemblyscript[/\\]/.test(tsconfigBase)) {
  // Use node resolution if the compiler is a normal dependency
@@ -84,6 +85,9 @@ console.log([
  colors.cyan(" ./tests/index.js"),
  " Example test to check that your module is indeed working.",
  "",
+ colors.cyan(" ./asconfig.json"),
+ " Configuration file defining both a 'debug' and a 'release' target.",
+ "",
  colors.cyan(" ./package.json"),
  " Package info containing the necessary commands to compile to WebAssembly.",
  "",
@@ -108,6 +112,7 @@ function createProject(answer) {
  ensureIndexJs();
  ensureTestsDirectory();
  ensureTestsIndexJs();
+ ensureAsconfigJson();
  console.log([
  colors.green("Done!"),
  "",
@@ -207,6 +212,35 @@ function ensureTsconfigJson() {
  console.log();
 }
 
+function ensureAsconfigJson() {
+ console.log("- Making sure that 'asconfig.json' is set up...");
+ if (!fs.existsSync(asconfigFile)) {
+ fs.writeFileSync(asconfigFile, JSON.stringify({
+ targets: {
+ debug: {
+ // -b build/untouched.wasm -t build/untouched.wat --sourceMap --debug
+ binaryFile: "build/untouched.wasm",
+ textFile: "build/untouched.wat",
+ sourceMap: true,
+ debug: true
+ },
+ release: {
+ // -b build/optimized.wasm -t build/optimized.wat --sourceMap --optimize
+ binaryFile: "build/optimized.wasm",
+ textFile: "build/optimized.wat",
+ sourceMap: true,
+ optimize: true
+ }
+ },
+ options: {}
+ }, null, 2));
+ console.log(colors.green(" Created: ") + asconfigFile);
+ } else {
+ console.log(colors.yellow(" Exists: ") + asconfigFile);
+ }
+ console.log();
+}
+
 function ensureEntryFile() {
  console.log("- Making sure that 'assembly/index.ts' exists...");
  if (!fs.existsSync(entryFile)) {
@@ -253,8 +287,8 @@ function ensureGitignore() {
 function ensurePackageJson() {
  console.log("- Making sure that 'package.json' contains the build commands...");
  const entryPath = path.relative(projectDir, entryFile).replace(/\\/g, "/");
- const buildUntouched = "asc " + entryPath + " -b build/untouched.wasm -t build/untouched.wat --sourceMap --debug";
- const buildOptimized = "asc " + entryPath + " -b build/optimized.wasm -t build/optimized.wat --sourceMap --optimize";
+ const buildUntouched = "asc " + entryPath + " --target debug";
+ const buildOptimized = "asc " + entryPath + " --target release";
  const buildAll = "npm run asbuild:untouched && npm run asbuild:optimized";
  if (!fs.existsSync(packageFile)) {
  fs.writeFileSync(packageFile, JSON.stringify({

cli/asc.js

@@ -194,7 +194,8 @@ exports.main = function main(argv, options, callback) {
  if (!stderr) throw Error("'options.stderr' must be specified");
 
  const opts = optionsUtil.parse(argv, exports.options);
- const args = opts.options;
+ let args = opts.options;
+
  argv = opts.arguments;
  if (args.noColors) {
  colorsUtil.stdout.supported =
@@ -270,6 +271,90 @@ exports.main = function main(argv, options, callback) {
 
  // Set up base directory
  const baseDir = args.baseDir ? path.resolve(args.baseDir) : ".";
+ const target = args.target;
+
+ // Once the baseDir is calculated, we can resolve the config, and its extensions
+ let asconfig = getAsconfig(args.config, baseDir, readFile);
+ let asconfigDir = baseDir;
+
+ const seenAsconfig = new Set();
+ seenAsconfig.add(path.join(baseDir, args.config));
+
+ while (asconfig) {
+ // merge target first, then merge options, then merge extended asconfigs
+ if (asconfig.targets && asconfig.targets[target]) {
+ args = optionsUtil.merge(exports.options, asconfig.targets[target], args);
+ }
+ if (asconfig.options) {
+ if (asconfig.options.transform) {
+ // ensure that a transform's path is relative to the current config
+ asconfig.options.transform = asconfig.options.transform.map(p => {
+ if (!path.isAbsolute(p)) {
+ if (p.startsWith(".")) {
+ return path.join(asconfigDir, p);
+ }
+ return require.resolve(p);
+ }
+ return p;
+ });
+ }
+ args = optionsUtil.merge(exports.options, args, asconfig.options);
+ }
+
+ // entries are added to the compilation
+ if (asconfig.entries) {
+ for (const entry of asconfig.entries) {
+ argv.push(
+ path.isAbsolute(entry)
+ ? entry
+ // the entry is relative to the asconfig directory
+ : path.join(asconfigDir, entry)
+ );
+ }
+ }
+
+ // asconfig "extends" another config, merging options of it's parent
+ if (asconfig.extends) {
+ asconfigDir = path.isAbsolute(asconfig.extends)
+ // absolute extension path means we know the exact directory and location
+ ? path.dirname(asconfig.extends)
+ // relative means we need to calculate a relative asconfigDir
+ : path.join(asconfigDir, path.dirname(asconfig.extends));
+ const fileName = path.basename(asconfig.extends);
+ const filePath = path.join(asconfigDir, fileName);
+ if (seenAsconfig.has(filePath)) {
+ asconfig = null;
+ } else {
+ seenAsconfig.add(filePath);
+ asconfig = getAsconfig(fileName, asconfigDir, readFile);
+ }
+ } else {
+ asconfig = null; // finished resolving the configuration chain
+ }
+ }
+
+ // If showConfig print args and exit
+ if (args.showConfig) {
+ stderr.write(JSON.stringify(args, null, 2));
+ return callback(null);
+ }
+
+ // This method resolves a path relative to the baseDir instead of process.cwd()
+ function resolveBasedir(arg) {
+ return path.resolve(baseDir, arg);
+ }
+
+ // create a unique set of values
+ function unique(values) {
+ return [...new Set(values)];
+ }
+
+ // returns a relative path from baseDir
+ function makeRelative(arg) {
+ return path.relative(baseDir, arg);
+ }
+ // postprocess we need to get absolute file locations argv
+ argv = unique(argv.map(resolveBasedir)).map(makeRelative);
 
  // Set up options
  const compilerOptions = assemblyscript.newOptions();
@@ -347,7 +432,7 @@ exports.main = function main(argv, options, callback) {
  const transforms = [];
  if (args.transform) {
  let tsNodeRegistered = false;
- let transformArgs = args.transform;
+ let transformArgs = unique(args.transform.map(resolveBasedir));
  for (let i = 0, k = transformArgs.length; i < k; ++i) {
  let filename = transformArgs[i].trim();
  if (!tsNodeRegistered && filename.endsWith(".ts")) { // ts-node requires .ts specifically
@@ -376,6 +461,7 @@ exports.main = function main(argv, options, callback) {
  }
  }
  }
+
  function applyTransform(name, ...args) {
  for (let i = 0, k = transforms.length; i < k; ++i) {
  let transform = transforms[i];
@@ -400,11 +486,12 @@ exports.main = function main(argv, options, callback) {
  assemblyscript.parse(program, exports.libraryFiles[libPath], exports.libraryPrefix + libPath + extension.ext, false);
  });
  });
- const customLibDirs = [];
+ let customLibDirs = [];
  if (args.lib) {
  let lib = args.lib;
- if (typeof lib === "string") lib = lib.split(",");
- Array.prototype.push.apply(customLibDirs, lib.map(lib => lib.trim()));
+ if (typeof lib === "string") lib = lib.trim().split(/\s*,\s*/);
+ customLibDirs.push(...lib.map(resolveBasedir));
+ customLibDirs = unique(customLibDirs); // `lib` and `customLibDirs` may include duplicates
  for (let i = 0, k = customLibDirs.length; i < k; ++i) { // custom
  let libDir = customLibDirs[i];
  let libFiles;
@@ -574,7 +661,7 @@ exports.main = function main(argv, options, callback) {
  const filename = argv[i];
 
  let sourcePath = String(filename).replace(/\\/g, "/").replace(extension.re, "").replace(/[\\/]$/, "");
- 
+
  // Setting the path to relative path
  sourcePath = path.isAbsolute(sourcePath) ? path.relative(baseDir, sourcePath) : sourcePath;
 
@@ -925,6 +1012,56 @@ exports.main = function main(argv, options, callback) {
  }
 };
 
+const toString = Object.prototype.toString;
+
+function isObject(arg) {
+ return toString.call(arg) === "[object Object]";
+}
+
+function getAsconfig(file, baseDir, readFile) {
+ const contents = readFile(file, baseDir);
+ const location = path.join(baseDir, file);
+ if (!contents) return null;
+
+ // obtain the configuration
+ let config;
+ try {
+ config = JSON.parse(contents);
+ } catch(ex) {
+ throw new Error("Asconfig is not valid json: " + location);
+ }
+
+ // validate asconfig shape
+ if (config.options && !isObject(config.options)) {
+ throw new Error("Asconfig.options is not an object: " + location);
+ }
+
+ if (config.include && !Array.isArray(config.include)) {
+ throw new Error("Asconfig.include is not an array: " + location);
+ }
+
+ if (config.targets) {
+ if (!isObject(config.targets)) {
+ throw new Error("Asconfig.targets is not an object: " + location);
+ }
+ const targets = Object.keys(config.targets);
+ for (let i = 0; i < targets.length; i++) {
+ const target = targets[i];
+ if (!isObject(config.targets[target])) {
+ throw new Error("Asconfig.targets." + target + " is not an object: " + location);
+ }
+ }
+ }
+
+ if (config.extends && typeof config.extends !== "string") {
+ throw new Error("Asconfig.extends is not a string: " + location);
+ }
+
+ return config;
+}
+
+exports.getAsconfig = getAsconfig;
+
 /** Checks diagnostics emitted so far for errors. */
 function checkDiagnostics(program, stderr) {
  var diagnostic;

cli/asc.json

@@ -17,6 +17,18 @@
  "type": "b",
  "default": false
  },
+ "config": {
+ "category": "General",
+ "description": "Configuration file to apply. CLI arguments take precedence.",
+ "type": "s",
+ "default": "asconfig.json"
+ },
+ "target": {
+ "category": "General",
+ "description": "Target configuration to use. Defaults to 'release'.",
+ "type": "s",
+ "default": "release"
+ },
 
  "optimize": {
  "category": "Optimization",
@@ -288,6 +300,11 @@
  "type": "b",
  "default": false
  },
+ "showConfig": {
+ "description": "Print computed compiler options and exit.",
+ "type": "b",
+ "default": false
+ },
  "measure": {
  "description": "Prints measuring information on I/O and compile times.",
  "type": "b",

package.json

@@ -59,11 +59,12 @@
  "check:config": "tsc --noEmit -p src --diagnostics --listFiles",
  "check:require": "tsc --noEmit --target ESNEXT --module commonjs --experimentalDecorators tests/require/index",
  "check:lint": "eslint --max-warnings 0 --ext js . && eslint --max-warnings 0 --ext ts .",
- "test": "npm run test:parser && npm run test:compiler && npm run test:packages && npm run test:extension",
+ "test": "npm run test:parser && npm run test:compiler && npm run test:packages && npm run test:extension && npm run test:asconfig",
  "test:parser": "node tests/parser",
  "test:compiler": "node tests/compiler",
  "test:packages": "cd tests/packages && npm run test",
  "test:extension": "cd tests/extension && npm run test",
+ "test:asconfig": "cd tests/asconfig && npm run test",
  "make": "npm run clean && npm test && npm run build && npm test",
  "all": "npm run check && npm run make",
  "docs": "typedoc --tsconfig tsconfig-docs.json --mode modules --name \"AssemblyScript Compiler API\" --out ./docs/api --ignoreCompilerErrors --excludeNotExported --excludePrivate --excludeExternals --exclude **/std/** --includeDeclarations --readme src/README.md",

tests/asconfig/complicated/asconfig.json

@@ -0,0 +1,16 @@
+{
+ "targets": {
+ "release": {
+ "optimize": true,
+ "runtime": "stub",
+ "initialMemory": 30,
+ "explicitStart": true,
+ "measure": true,
+ "pedantic": true
+ }
+ },
+ "options": {
+ "initialMemory": 100,
+ "enable": ["simd"]
+ }
+}

tests/asconfig/complicated/assembly/index.ts

@@ -0,0 +1,6 @@
+assert(ASC_OPTIMIZE_LEVEL == 3);
+assert(ASC_SHRINK_LEVEL == 1);
+assert(ASC_FEATURE_SIMD);
+let size = memory.size();
+trace("size", 1, size);
+assert(size == 30);

tests/asconfig/complicated/package.json

@@ -0,0 +1,6 @@
+{
+ "private": true,
+ "scripts": {
+ "test": "node ../index.js"
+ }
+}

tests/asconfig/cyclical/asconfig.json

@@ -0,0 +1,3 @@
+{
+ "extends": "./extends.json"
+}

tests/asconfig/cyclical/assembly/index.ts

@@ -0,0 +1 @@
+assert(true);

tests/asconfig/cyclical/extends.json

@@ -0,0 +1,3 @@
+{
+ "extends": "./asconfig.json"
+}

tests/asconfig/cyclical/package.json

@@ -0,0 +1,6 @@
+{
+ "private": true,
+ "scripts": {
+ "test": "node ../index.js"
+ }
+}

tests/asconfig/entry-points/asconfig.json

@@ -0,0 +1,3 @@
+{
+ "entries": ["assembly/globals.ts"]
+}

tests/asconfig/entry-points/assembly/globals.ts

@@ -0,0 +1,3 @@
+// @ts-ignore: decorator
+@global const answerToLife = 42;
+assert(answerToLife);

tests/asconfig/entry-points/assembly/index.ts

@@ -0,0 +1,2 @@
+
+assert(answerToLife == 42);

tests/asconfig/entry-points/nested/asconfig.json

@@ -0,0 +1,3 @@
+{
+ "extends": "../asconfig.json"
+}

tests/asconfig/entry-points/nested/assembly/index.ts

@@ -0,0 +1 @@
+assert(answerToLife == 42);

tests/asconfig/entry-points/nested/package.json

@@ -0,0 +1,6 @@
+{
+ "private": true,
+ "scripts": {
+ "test": "node ../../index.js"
+ }
+}