Add .json and .ts deno-workspace file support (#11)

* refractor: Use testDenoXRun in scripts.test.ts

* feat: Add support for .json deno-worspace file

* feat: Add extname dep and assertThrowsAsync

* bugfix: Export project interfaces

* bugfix: If globals is unddefined use a empty hash

* bugfix: Type argValue in build cli arguments

* bugfix: Import missing types in deno_options/parse.ts

* feat: Add support for ts file workspace

* bugfix: Catch TypeError in deno_workspace ts loading

* test: Add test for .deno-workspace.ts

* refractor: separate the read and check if list of file exist logic

* refractor: Error handling in load workspace

* style: Lint files

* test: Add tmate to github workflow

* chore: Fix eslint installation in github workflow

* style: Fix eslint error

* style: Refractor methods that had more than 20 lines

* style: Add linting rules

* test: Add test for deno_options parsing

* test: Add test for utils

* test: Add test for validate deno options

* test: Add test for file

* test: Replace in fixture allow-net by seed

* test: Add tests for false permissions

* fix: Script options not passed properly

* style: Remove no-undef eslint rule

* chore: Remove node_modules from CI

* chore: Limit deno test to src and test folder

* bugfix: deno-workspace.ts file not loading on windows

* test: Fix read file test

* feat: Bump version

* doc: Add documentation for JSON and TS workspace files

Author: BentoumiTech

.eslintrc.js

@@ -0,0 +1,51 @@
+module.exports = {
+  root: true,
+  parser: "@typescript-eslint/parser",
+  plugins: [
+    "@typescript-eslint",
+  ],
+  rules: {
+    "@typescript-eslint/ban-ts-ignore": 0,
+    "no-console": 0,
+    "no-else-return": "error",
+    "@typescript-eslint/no-use-before-define": 0,
+    "@typescript-eslint/camelcase": 0,
+    "no-prototype-builtins": 0,
+    "max-lines-per-function": [
+      "error",
+      {
+        "max": 20,
+        "skipComments": true,
+      },
+    ],
+    "no-shadow": "error",
+    "max-params": [
+      "error",
+      3,
+    ],
+    "max-statements-per-line": [
+      "error",
+      {
+        "max": 2,
+      },
+    ],
+    "complexity": [
+      "error",
+      15,
+    ],
+    "no-undef": 0,
+  },
+  "overrides": [
+    {
+      "files": ["*.test.ts"],
+      "rules": {
+        "max-lines-per-function": 0,
+      },
+    },
+  ],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+  ],
+};

.github/workflows/ci.yml

@@ -20,5 +20,10 @@ jobs:
     - uses: denolib/setup-deno@master
       with:
         deno-version: ${{ matrix.deno }}
+    - uses: actions/setup-node@v1
+      with:
+        node-version: '12'
+    - run: npm install typescript eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin tsc-silent --save-dev
+    - run: ./node_modules/.bin/eslint **/**.ts --ext .ts
     - run: deno install -Af denox.ts
-    - run: deno test -A --failfast
+    - run: deno test -A --failfast src/ test/

README.md

@@ -10,7 +10,6 @@
   <img src="https://img.shields.io/github/v/tag/bentoumitech/denox?style=flat-square" alt="latest SemVer"/>
   <img src="https://img.shields.io/badge/contribution-welcome-brightgreen.svg?style=flat-square" alt="Contribution welcome"/>
   <img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square" alt="Commitizen friendly"/>
-  <img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square" alt="Commitizen friendly"/>
   <img src="https://img.shields.io/badge/semantic-release-e10079.svg?style=flat-square" alt="Semantic release"/>
   <img src="https://img.shields.io/github/license/BentoumiTech/denox?logo=MIT&style=flat-square" alt="MIT License"/>
   <br />
@@ -35,7 +34,7 @@ $ deno install -Af -n denox https://denopkg.com/BentoumiTech/denox/denox.ts
 
 ## Overview
 
-DenoX is a script runner and workspace wrapper for Deno
+DenoX is a cross platform script runner and workspace wrapper for Deno
 
 Using DenoX, you can set up your workspace scripts permissions and options in declarative code.
 
@@ -53,13 +52,14 @@ $ denox run start
 
 - **DRY** Only write your permissions and options once.
 - **Packaged** Your code can run on a different machine with a short single command `denox run start`
+- **Cross Platform** DenoX support and is tested on Linux, Mac OS and Windows.
 - **Extensible** :soon:
 
 ## Usage
 
 ```bash
 $ denox --help
-denox v0.2.0
+denox v0.4.0
 
 Usage:
   $ denox <command> [options]
@@ -80,13 +80,67 @@ denox run start
 
 ## Getting Started
 
-Create a file named `deno-workspace.yml` at the root of your Deno project.
+### `deno-workspace` file
+
+Scripts and options need to be defined in a `deno-workspace` file at the root of your project.
+
+DenoX supports YAML, JSON and typescript as format for `deno-workspace`.
+
+In the following examples running `$ denox run start` will execute main.ts file with `example.com` networking permissions
+
+#### YAML
+
+`deno-workspace.yml`
 
-> Note: `deno-workspace.yml` format is YAML but it also supports JSON
+```
+scripts:
+  start:
+    file: main.ts
+    deno_options:
+      allow-net: example.com
+```
+
+#### JSON
+
+`deno-workspace.json`
+
+```
+{
+  "scripts": {
+    "start": {
+      "file": "main.ts",
+      "deno_options": {
+        "allow-net": "example.com"
+      }
+    }
+  }
+}
+```
+
+#### Typescript
+
+`deno-workspace.ts`
+
+```
+import { DenoWorkspace } from "https://denopkg.com/BentoumiTech/denox/src/interfaces.ts";
+
+const workspace: DenoWorkspace = {
+  "scripts": {
+    "start": {
+      "file": "main.ts",
+      "deno_options": {
+        "allow-net": "example.com"
+      }
+    },
+  },
+};
+
+export { workspace };
+```
 
 ## Scripts
 
-You can easily run scripts using denox by adding them to the "scripts" field in `deno-workspace.yml` and run them with `denox run <script-name>`.
+You can easily run scripts using denox by adding them to the "scripts" field in `deno-workspace` and run them with `denox run <script-name>`.
 
 ### Example:
 
@@ -103,6 +157,9 @@ scripts:
     deno_options:
       allow-net: localhost
       reload: true
+      v8-flags:
+        - --regexp-tier-up
+        - --adjust-os-scheduling-parameters true
 ```
 
 ## Options

denox.ts

@@ -12,7 +12,7 @@ cli
     "Run a script",
     { allowUnknownOptions: true, ignoreOptionDefaultValue: true },
   )
-  .example("denox run start arg1 arg2")
+  .example("denox run start arg1 arg2 --namedArg=value")
   .action(run);
 
 // @ts-ignore

deps.ts

@@ -1,6 +1,7 @@
 export { parse as parseYaml } from "https://deno.land/[email protected]/encoding/yaml.ts";
 export { YAMLError } from "https://deno.land/[email protected]/encoding/yaml/error.ts";
 export { red } from "https://deno.land/[email protected]/fmt/colors.ts";
+export { extname, resolve } from "https://deno.land/[email protected]/path/mod.ts";
 
 // @deno-types="https://unpkg.com/[email protected]/mod.d.ts"
 export { cac } from "https://unpkg.com/[email protected]/mod.js";

dev_deps.ts

@@ -1,8 +1,11 @@
+export * from "./deps.ts";
+
 export {
   assertEquals,
   assertArrayContains,
   assertThrows,
   assertStrContains,
+  assertThrowsAsync,
 } from "https://deno.land/[email protected]/testing/asserts.ts";
 
-export { resolve, join } from "https://deno.land/[email protected]/path/mod.ts";
+export { join } from "https://deno.land/[email protected]/path/mod.ts";

src/const.ts

@@ -1,4 +1,4 @@
-const CURRENT_VERSION = "0.3.0";
+const CURRENT_VERSION = "0.4.0";
 const GITHUB_REPO_NAME = "BentoumiTech/denox";
 const DENO_WORKSPACE_FILES = [
   "deno-workspace.yml",
@@ -7,6 +7,10 @@ const DENO_WORKSPACE_FILES = [
   ".deno-workspace",
   ".deno-workspace.yml",
   ".deno-workspace.yaml",
+  "deno-workspace.json",
+  ".deno-workspace.json",
+  "deno-workspace.ts",
+  ".deno-workspace.ts",
 ];
 
 export { CURRENT_VERSION, GITHUB_REPO_NAME, DENO_WORKSPACE_FILES };

src/deno_options/__tests__/parse.test.ts

@@ -0,0 +1,67 @@
+import { assertEquals, assertThrows } from "../../../dev_deps.ts";
+import { parseDenoOptions } from "../parse.ts";
+import { DenoOptionIncorrectType } from "../../utils/DenoXErrors.ts";
+
+Deno.test("deno_options not defined", () => {
+  const script = { file: "" };
+  const global = {};
+  const denoOptions = parseDenoOptions(global, script);
+
+  assertEquals(
+    denoOptions,
+    [],
+  );
+});
+
+Deno.test("deno_options only defined in globals", () => {
+  const script = { file: "" };
+  const global = { deno_options: { "allow-read": true } };
+  const denoOptions = parseDenoOptions(global, script);
+
+  assertEquals(
+    denoOptions,
+    ["--allow-read"],
+  );
+});
+
+Deno.test("deno_options only defined in script", () => {
+  const script = { deno_options: { "allow-read": true }, file: "" };
+  const global = {};
+  const denoOptions = parseDenoOptions(global, script);
+
+  assertEquals(
+    denoOptions,
+    ["--allow-read"],
+  );
+});
+
+Deno.test("deno_options only defined in script and globals", () => {
+  const script = { deno_options: { "allow-read": true }, file: "" };
+  const global = { deno_options: { "allow-write": true } };
+  const denoOptions = parseDenoOptions(global, script);
+
+  assertEquals(
+    denoOptions,
+    ["--allow-write", "--allow-read"],
+  );
+});
+
+Deno.test("deno_options script overwrite globals one", () => {
+  const script = { deno_options: { "allow-read": false }, file: "" };
+  const global = { deno_options: { "allow-read": true } };
+  const denoOptions = parseDenoOptions(global, script);
+
+  assertEquals(
+    denoOptions,
+    [],
+  );
+});
+
+Deno.test("validation error get thrown", () => {
+  const script = { deno_options: { "allow-read": false }, file: "" };
+  const global = { deno_options: { "allow-hrtime": "string" } };
+
+  assertThrows(() => {
+    parseDenoOptions(global, script);
+  }, DenoOptionIncorrectType);
+});

src/deno_options/__tests__/utils.test.ts

@@ -0,0 +1,65 @@
+import { assertEquals } from "../../../dev_deps.ts";
+import { getOptionType } from "../utils.ts";
+
+Deno.test("string[]", () => {
+  const optionType = getOptionType(["first", "second"]);
+
+  assertEquals(
+    optionType,
+    "string[]",
+  );
+});
+
+Deno.test("string[] with numbers", () => {
+  const optionType = getOptionType(["first", 2]);
+
+  assertEquals(
+    optionType,
+    "string[]",
+  );
+});
+
+Deno.test("mixed[]", () => {
+  const optionType = getOptionType(["first", { "test": "string" }]);
+
+  assertEquals(
+    optionType,
+    "mixed[]",
+  );
+});
+
+Deno.test("object", () => {
+  const optionType = getOptionType({ "test": "string" });
+
+  assertEquals(
+    optionType,
+    "object",
+  );
+});
+
+Deno.test("string", () => {
+  const optionType = getOptionType("string");
+
+  assertEquals(
+    optionType,
+    "string",
+  );
+});
+
+Deno.test("number", () => {
+  const optionType = getOptionType(1);
+
+  assertEquals(
+    optionType,
+    "number",
+  );
+});
+
+Deno.test("boolean", () => {
+  const optionType = getOptionType(true);
+
+  assertEquals(
+    optionType,
+    "boolean",
+  );
+});

src/deno_options/__tests__/validate.test.ts

@@ -0,0 +1,32 @@
+import { assertThrows } from "../../../dev_deps.ts";
+import { validateOptions } from "../validate.ts";
+import {
+  DenoOptionNotRecognized,
+  DenoOptionIncorrectType,
+} from "../../utils/DenoXErrors.ts";
+
+Deno.test("invalid option name error get thrown", () => {
+  const options = { "invalid-option": false };
+
+  assertThrows(() => {
+    validateOptions(options);
+  }, DenoOptionNotRecognized);
+});
+
+Deno.test("invalid option value error get thrown", () => {
+  const options = { "allow-hrtime": "string" };
+
+  assertThrows(() => {
+    validateOptions(options);
+  }, DenoOptionIncorrectType);
+});
+
+Deno.test("not throw for valid values", () => {
+  const options = {
+    "allow-hrtime": true,
+    "allow-read": ".",
+    "allow-write": true,
+    "allow-net": ["google.com", "github.com"],
+  };
+  validateOptions(options);
+});