refactor: rewrite core in typescript (#536)

* improve declaration file

* type check parseAttributes.js

* type check parseFrontmatter.js

* type check parseFrontmatter.js

* convert saber-log to typescript

* compile saber

* convert assetsAttribute.js to typescript

* migrate to eslint

* some fixes

* convert BrowserApi to typescript

* conevrt Transformers to typescript

* convert Compiler to ts

* convert WebpackUtils to typescript

* convert index.js to typescript with a lot of todos and ts-ignore

* type-check website/saber-config.js

* generate typedoc

* fix path to babel preset

* remove TODOs related to Saber

* remove TODOs related to hooks

* remove TODOs related to renderer

remove custom renderer support (since we won't be able to  add react support anytime soon)

* fix path to saber cli

* make website a workspace to simplify commands

* use the transform method

* remove more TODOs

* remove ts-ignore for api.config

* disable @typescript-eslint/triple-slash-reference for now

* no ts-ignore

* resolve lint errors

* fix jest config

* exclude dist

.gitignore

@@ -5,3 +5,4 @@ public
 .DS_Store
 examples/*/yarn.lock
 examples/*/package-lock.json
+packages/*/types

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+  "eslint.validate": ["javascript", "javascriptreact", "typescript"],
+  "eslint.enable": true,
+  "eslint.workingDirectories": [
+    {
+      "directory": "packages/saber",
+      "changeProcessCWD": true
+    }
+  ]
+}

CONTRIBUTING.md

@@ -11,13 +11,12 @@ cd saber
 # Install dependencies
 yarn
 
-# Link the `saber` binary
+# Link the `saber` binary if you want to run it globally
 cd packages/saber
 yarn link
 
 # If you wanna run the website locally
 cd website
-yarn
 yarn dev # which uses the global `saber` command
 ```
 

lerna.json

@@ -1,4 +1,5 @@
 {
   "packages": ["packages/*", "other-packages/*"],
-  "version": "independent"
+  "version": "independent",
+  "npmClient": "yarn"
 }

other-packages/eslint-config-saber/index.js

@@ -0,0 +1,42 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    warnOnUnsupportedTypeScriptVersion: false,
+    sourceType: 'module',
+    jsx: false,
+    project: 'tsconfig.json'
+  },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+    'plugin:prettier/recommended'
+  ],
+  env: {
+    node: true,
+    jest: true,
+    es2017: true
+  },
+  rules: {
+    // Enable this rule when all files are migated to TS
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/camelcase': 'off',
+    // Enable this rule later, it explodes the terminal
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/member-delimiter-style': [
+      'error',
+      {
+        multiline: {
+          delimiter: 'none',
+          requireLast: false
+        },
+        singleline: {
+          delimiter: 'semi',
+          requireLast: false
+        }
+      }
+    ],
+    '@typescript-eslint/prefer-includes': 'off'
+  }
+}

other-packages/eslint-config-saber/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "eslint-config-saber",
+  "version": "0.0.0",
+  "description": "ESLint config for core Saber repos",
+  "man": "index.js",
+  "files": [
+    "index.js"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^2.6.0",
+    "@typescript-eslint/parser": "^2.6.0",
+    "eslint-config-prettier": "6.3.0",
+    "eslint-plugin-prettier": "3.1.1"
+  }
+}

package.json

@@ -3,7 +3,7 @@
   "name": "saber",
   "scripts": {
     "test": "npm run lint && lerna run test",
-    "lint": "xo",
+    "lint": "lerna run lint",
     "commit": "git-cz",
     "prepare": "lerna run prepublishOnly"
   },
@@ -18,39 +18,17 @@
     "conf": "6.0.1",
     "cz-conventional-changelog": "3.0.2",
     "enquirer": "^2.3.1",
-    "eslint-config-prettier": "6.3.0",
-    "eslint-config-rem": "4.0.0",
-    "eslint-plugin-prettier": "3.1.1",
+    "eslint": "^6.6.0",
     "husky": "3.0.5",
+    "jest": "^24.9.0",
     "lerna": "3.16.4",
     "lint-staged": "8.1.6",
     "prettier": "1.18.2",
-    "xo": "0.24.0"
+    "typedoc": "^0.15.0",
+    "typescript": "^3.8.0-dev.20191031"
   },
-  "xo": {
-    "extends": [
-      "rem",
-      "plugin:prettier/recommended"
-    ],
-    "rules": {
-      "import/no-unassigned-import": "off",
-      "unicorn/filename-case": "off",
-      "no-await-in-loop": "off",
-      "unicorn/no-abusive-eslint-disable": "off",
-      "camelcase": "off"
-    },
-    "ignore": [
-      "**/dist/**",
-      "**/vendor/**",
-      "*.min.js",
-      "**/vue-renderer/app/**",
-      "**/example/**",
-      "**/examples/**",
-      "website/**"
-    ],
-    "envs": [
-      "jest"
-    ]
+  "resolutions": {
+    "typedoc/typescript": "^3.8.0-dev.20191031"
   },
   "husky": {
     "hooks": {
@@ -59,10 +37,6 @@
   },
   "lint-staged": {
     "linters": {
-      "*.js": [
-        "xo --fix",
-        "git add"
-      ],
       "*.{json,md}": [
         "prettier --write",
         "git add"
@@ -79,7 +53,8 @@
   },
   "workspaces": [
     "packages/*",
-    "other-packages/*"
+    "other-packages/*",
+    "website"
   ],
   "config": {
     "commitizen": {

packages/saber-log/package.json

@@ -1,9 +1,18 @@
 {
   "name": "saber-log",
   "version": "0.3.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
-    "index.js",
-    "colors.js"
+    "dist"
   ],
-  "license": "MIT"
+  "license": "MIT",
+  "scripts": {
+    "prepublishOnly": "yarn build",
+    "build": "rollup -c"
+  },
+  "devDependencies": {
+    "rollup": "^1.26.0",
+    "rollup-plugin-typescript2": "^0.24.3"
+  }
 }

packages/saber-log/rollup.config.js

@@ -0,0 +1,16 @@
+export default {
+  input: 'src/index.ts',
+  output: {
+    file: 'dist/index.js',
+    format: 'cjs'
+  },
+  plugins: [
+    require('rollup-plugin-typescript2')({
+      tsconfigOverride: {
+        compilerOptions: {
+          declaration: true
+        }
+      }
+    })
+  ]
+}

packages/saber-log/colors.js → packages/saber-log/src/colors.ts

@@ -1,3 +1,4 @@
+// @ts-nocheck
 /* eslint-disable */
 let enabled =
   process.env.FORCE_COLOR ||
@@ -25,7 +26,7 @@ const init = (open, close) => {
   )
 }
 
-module.exports = {
+export const colors = {
   options: Object.defineProperty({}, 'enabled', {
     get: () => enabled,
     set: value => (enabled = value)

packages/saber-log/index.js → packages/saber-log/src/index.ts

@@ -1,4 +1,4 @@
-const colors = require('./colors')
+import { colors } from './colors'
 
 const chars = {
   info: colors.cyan('info'),
@@ -7,14 +7,24 @@ const chars = {
   error: colors.red('error')
 }
 
-const defined = n => typeof n !== 'undefined'
+interface ILogConstructorOptions {
+  logLevel?: number
+}
+
+
+/**
+ * Check if a value is `undefined`
+ */
+const defined = (n: any) => typeof n !== 'undefined'
+
+export class Log {
+  options: ILogConstructorOptions
 
-class Log {
   constructor() {
-    this.setOptions()
+    this.options = {}
   }
 
-  setOptions(options) {
+  setOptions(options: ILogConstructorOptions) {
     this.options = Object.assign({}, this.options, options)
   }
 
@@ -32,44 +42,64 @@ class Log {
     return Number(logLevel)
   }
 
-  log(...args) {
+  /**
+   * Log anything using `console.log`
+   */
+  log(...args: any[]) {
     console.log(...args)
   }
 
-  verbose(...args) {
+  /**
+   * Verbose logs
+   */
+  verbose(...args: any[]) {
     if (this.logLevel < 4) return
 
     const messages = args.map(arg => (typeof arg === 'function' ? arg() : arg))
     this.log(colors.dim('[verbose]'), ...messages)
   }
 
-  info(...args) {
+  /**
+   * Info logs
+   */
+  info(...args: any[]) {
     if (this.logLevel < 3) return
 
     this.log(`[${chars.info}]`, ...args)
   }
 
-  warn(...args) {
+  /**
+   * Warning logs
+   */
+  warn(...args: any[]) {
     if (this.logLevel < 2) return
 
     this.log(`[${chars.warning}]`, ...args)
   }
 
-  error(...args) {
+  /**
+   * Error logs
+   */
+  error(...args: any[]) {
     if (this.logLevel < 1) return
 
     this.log(`[${chars.error}]`, ...args)
   }
 
-  success(...args) {
+  /**
+   * Success logs
+   */
+  success(...args: any[]) {
     if (this.logLevel < 3) return
 
     this.log(`[${chars.success}]`, ...args)
   }
 }
 
-module.exports = {
-  log: new Log(),
+const log = new Log()
+
+export {
+  log,
   colors,
   chars
 }

packages/saber-log/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "include": ["src"],
+  "compilerOptions": {
+    "module": "esnext"
+  }
+}

packages/saber-plugin-code-copy/package.json

@@ -7,7 +7,6 @@
   "files": [
     "lib"
   ],
-  "xo": false,
   "peerDependencies": {
     "saber": ">=0.7.0"
   },

packages/saber-plugin-feed/package.json

@@ -10,7 +10,6 @@
   "files": [
     "lib"
   ],
-  "xo": false,
   "dependencies": {
     "feed": "^4.0.0"
   },

packages/saber-plugin-git-modification-time/package.json

@@ -7,7 +7,6 @@
   "files": [
     "lib"
   ],
-  "xo": false,
   "dependencies": {
     "execa": "^2.0.3"
   },

packages/saber-plugin-meta-redirect/package.json

@@ -11,7 +11,6 @@
   "files": [
     "lib"
   ],
-  "xo": false,
   "dependencies": {
     "url-join": "^4.0.0"
   },

packages/saber-plugin-netlify-redirect/package.json

@@ -11,7 +11,6 @@
   "files": [
     "lib"
   ],
-  "xo": false,
   "dependencies": {
     "url-join": "^4.0.0"
   },

packages/saber-plugin-pwa/package.json

@@ -7,7 +7,6 @@
   "files": [
     "lib"
   ],
-  "xo": false,
   "peerDependencies": {
     "saber": ">=0.7.0"
   },

packages/saber-plugin-transformer-html/package.json

@@ -11,7 +11,6 @@
   "files": [
     "lib"
   ],
-  "xo": false,
   "dependencies": {
     "extract-sfc-blocks": "^0.0.2"
   },