extwee 1.6.2 → 2.0.0

package/package.json

@@ -1,45 +1,60 @@
-{
-  "name": "extwee",
-  "version": "1.6.2",
-  "description": "A Twee 3 compiler written in JS.",
-  "author": "Dan Cox",
-  "main": "index.js",
-  "scripts": {
-    "start": "node main.js",
-    "test": "nyc mocha test/test.js",
-    "lint": "eslint src/**/*.js --fix",
-    "report-coverage": "nyc report --reporter=text-lcov > coverage.lcov"
-  },
-  "keywords": [
-    "twine",
-    "twee",
-    "parser",
-    "compiler"
-  ],
-  "license": "MIT",
-  "dependencies": {
-    "chokidar": "^3.3.0",
-    "clean-css": "^4.2.3",
-    "node-html-parser": "^1.2.3",
-    "shelljs": "^0.8.3",
-    "yargs": "^15.0.2"
-  },
-  "devDependencies": {
-    "eslint": "^6.8.0",
-    "eslint-config-standard": "^14.1.0",
-    "eslint-plugin-import": "^2.20.1",
-    "eslint-plugin-jsdoc": "^21.0.0",
-    "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-standard": "^4.0.1",
-    "mocha": "^7.0.1",
-    "nyc": "^15.0.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/videlais/extwee"
-  },
-  "bugs": {
-    "url": "https://github.com/videlais/extwee/issues"
-  }
-}
+{
+  "name": "extwee",
+  "version": "2.0.0",
+  "description": "A Twee 3 compiler written in JS.",
+  "author": "Dan Cox",
+  "main": "index.js",
+  "bin": {
+    "extwee": "bin/extwee.js"
+  },
+  "scripts": {
+    "test": "jest --silent --runInBand --coverage --colors",
+    "test:watch": "jest --watch",
+    "lint": "eslint ./src/**/*.js --fix",
+    "lint:test": "eslint ./test/*.test.js --fix",
+    "all": "npm run lint && npm run lint:test && npm run test"
+  },
+  "keywords": [
+    "twine",
+    "twee",
+    "parser",
+    "compiler"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "commander": "^4.1.1",
+    "node-html-parser": "^1.2.16",
+    "uuid": "^8.3.2"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.12.10",
+    "@babel/core": "^7.12.10",
+    "@babel/eslint-parser": "^7.12.1",
+    "@babel/eslint-plugin": "^7.12.1",
+    "@babel/plugin-proposal-class-properties": "^7.12.1",
+    "@babel/plugin-transform-runtime": "^7.12.10",
+    "@babel/polyfill": "^7.12.1",
+    "@babel/preset-env": "^7.12.11",
+    "babel-loader": "^8.2.2",
+    "core-js": "^3.8.1",
+    "eslint": "^7.7.0",
+    "eslint-config-standard": "^14.1.0",
+    "eslint-plugin-import": "^2.20.1",
+    "eslint-plugin-jest": "^24.1.3",
+    "eslint-plugin-jsdoc": "^30.2.1",
+    "eslint-plugin-node": "^11.0.0",
+    "eslint-plugin-promise": "^4.2.1",
+    "eslint-plugin-standard": "^4.0.1",
+    "jest": "^27.3.1",
+    "semver": "^5.7.1",
+    "shelljs": "^0.8.4"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/videlais/extwee"
+  },
+  "bugs": {
+    "url": "https://github.com/videlais/extwee/issues"
+  },
+  "type": "module"
+}

package/src/FileReader.js

@@ -1,35 +1,33 @@
-const fs = require('fs');
-/**
- * @class FileReader
- * @module FileReader
- */
-class FileReader {
-  /**
-   * @function FileReader
-   * @class
-   * @param {string} file - File to read
-   */
-  constructor (file) {
-    this.contents = '';
-    this.readFile(file);
-  }
-
-  /**
-   * Read a text file
-   *
-   * @function readFile
-   * @param {string} file - File to read
-   * @returns {void}
-   */
-  readFile (file) {
-    // Attempt to find the file
-    if (fs.existsSync(file)) {
-      // The file exists.
-      this.contents = fs.readFileSync(file, 'utf8');
-    } else {
-      throw new Error('Error: File not found!');
-    }
-  }
-}
-
-module.exports = FileReader;
+import fs from 'fs';
+/**
+ * @class FileReader
+ * @module FileReader
+ */
+export default class FileReader {
+  /**
+   * Read a text file
+   *
+   * @static
+   * @public
+   * @function readFile
+   * @memberof FileReader
+   * @param {string} file - Path of file to read
+   * @returns {string} Content of file
+   */
+  static read (file) {
+    // Setup default value
+    let contents = '';
+
+    // Attempt to find the file
+    if (fs.existsSync(file)) {
+      // The file exists.
+      contents = fs.readFileSync(file, 'utf8');
+    } else {
+      // Throw error if file does not exist
+      throw new Error('Error: File not found!');
+    }
+
+    // Return default or updated values
+    return contents;
+  }
+}