Small package-level improvements (#408)

ark120202 · Perryvw · commit 14bbeb363500 · 2019-02-20T21:32:17.000+01:00
* Replace .npmignore with files property

* Add EditorConfig

* Remove year from license

* Swap index and tstl cli files

* Replace deprecated circular-json with flatted

* Change tsconfig target to es2017

Supported node version (&gt;=8.5.0) supports it.

* Replace exclude in tsconfig with include + exclude

* Remove uselss files ignore pattern

* Change editorconfig indent for yaml files to 2 spaces
diff --git a/.codecov.yml b/.codecov.yml
@@ -8,4 +8,4 @@ coverage:
         threshold: null
         base: auto
     changes: off
-    patch: off
+    patch: off
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.yml]
+indent_size = 2
diff --git a/.npmignore b/.npmignore
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 [fullname]
+Copyright (c) [fullname]
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -9,8 +9,13 @@
         "tstl",
         "transpiler"
     ],
-    "main": "dist/tstl.js",
-    "types": "dist/tstl.d.ts",
+    "files": [
+        "dist/**/*.js",
+        "dist/**/*.lua",
+        "dist/**/*.ts"
+    ],
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
     "scripts": {
         "build": "tsc -p tsconfig.json && npm run build-lualib",
         "build-lualib": "ts-node ./build_lualib.ts",
@@ -30,7 +35,7 @@
         "style-check": "tslint -p . && tslint -c ./tslint.json src/lualib/*.ts"
     },
     "bin": {
-        "tstl": "./dist/index.js"
+        "tstl": "./dist/tstl.js"
     },
     "nyc": {
         "all": true,
@@ -54,10 +59,10 @@
         "@types/glob": "^5.0.35",
         "@types/node": "^9.6.23",
         "alsatian": "^2.3.0",
-        "circular-json": "^0.5.5",
         "codecov": "3.0.2",
         "deep-equal": "^1.0.1",
         "fengari": "^0.1.2",
+        "flatted": "^2.0.0",
         "glob": "^7.1.2",
         "nyc": "^13.3.0",
         "rimraf": "^2.6.3",
diff --git a/src/index.ts b/src/index.ts
@@ -1,5 +1,5 @@
-#!/usr/bin/env node
-
-import {compile} from "./Compiler";
-
-compile(process.argv.slice(2));
+export {parseCommandLine} from "./CommandLineParser";
+export {compile, compileFilesWithOptions, transpileString, watchWithOptions} from "./Compiler";
+export {CompilerOptions, LuaLibImportKind, LuaTarget,} from "./CompilerOptions";
+export {LuaLibFeature,} from "./LuaLib";
+export {LuaTranspiler,} from "./LuaTranspiler";
diff --git a/src/tstl.ts b/src/tstl.ts
@@ -1,5 +1,5 @@
-export {parseCommandLine} from "./CommandLineParser";
-export {compile, compileFilesWithOptions, transpileString, watchWithOptions} from "./Compiler";
-export {CompilerOptions, LuaLibImportKind, LuaTarget,} from "./CompilerOptions";
-export {LuaLibFeature,} from "./LuaLib";
-export {LuaTranspiler,} from "./LuaTranspiler";
+#!/usr/bin/env node
+
+import {compile} from "./Compiler";
+
+compile(process.argv.slice(2));
diff --git a/test/test_thread.ts b/test/test_thread.ts
@@ -1,5 +1,5 @@
 import { MatchError, TestRunner, TestSet, TestOutcome } from "alsatian";
-import * as JSON from "circular-json";
+import * as flatted from "flatted";
 
 module.exports = (input, done) => {
     const testSet = TestSet.create();
@@ -12,7 +12,7 @@ module.exports = (input, done) => {
     testRunner.onTestComplete(result => {
         if (result.outcome === TestOutcome.Fail) {
             if (result.error instanceof MatchError) {
-                console.log(`Test ${result.testFixture.description}, ${result.test.key}(${JSON.stringify(result.testCase.caseArguments)}) Failed!`);
+                console.log(`Test ${result.testFixture.description}, ${result.test.key}(${flatted.stringify(result.testCase.caseArguments)}) Failed!`);
                 console.log(" ---\n" +
                 '   message: "' +
                 result.error.message +
diff --git a/test/tsconfig.json b/test/tsconfig.json
@@ -2,7 +2,7 @@
     "compilerOptions": {
         "experimentalDecorators": true,
         "sourceMap": true,
-        "target": "es6",
+        "target": "es2017",
         "module": "commonjs"
     },
     "exclude": [
diff --git a/tsconfig.json b/tsconfig.json
@@ -7,8 +7,9 @@
         "declaration": true,
         "sourceMap": true,
         "experimentalDecorators": true,
-        "target": "es6",
+        "target": "es2017",
         "module": "commonjs"
     },
-    "exclude": ["test/**/*", "build_lualib.ts", "src/lualib", "dist/**/*"]
+    "include": ["src"],
+    "exclude": ["src/lualib"]
 }
