Merge pull request #1 from appworks-lab/release-next

[WIP] release-next

Author: alvinhui

.commitlintrc.js

@@ -0,0 +1,3 @@
+const { getCommitlintConfig } = require('@iceworks/spec');
+
+module.exports = getCommitlintConfig('react');

.eslintrc.js

@@ -4,5 +4,9 @@ module.exports = getESLintConfig('react-ts', {
   rules: {
     'react/jsx-filename-extension': 0,
     '@typescript-eslint/explicit-function-return-type': 0,
+    'react-hooks/exhaustive-deps': 0,
+    '@iceworks/best-practices/recommend-polyfill': 0,
+    'import/order': 1,
+    'no-param-reassign': 0
   },
 });

.github/contributing.md

@@ -0,0 +1,34 @@
+# Contributing Guide
+
+Hi! We are really excited that you are interested in contributing to Toolkit. Before submitting your contribution, please make sure to take a moment and read through the following guide:
+
+## Repo Setup
+
+```bash
+# install deps
+$ npm run setup
+```
+
+## Development and Debugging
+
+```bash
+# watch and start electron
+$ npm run start
+```
+
+You can also debug the electron app by the following two scripts:
+
+```bash
+# watch web and tsc
+$ npm run watch
+
+# start electron
+$ npm run start:electron
+```
+
+## Deploy
+
+```bash
+# build the electron
+$ npm run package
+```

.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: ci
+
+on: [push]
+
+jobs:
+  build-and-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set branch name
+        run: echo >>$GITHUB_ENV BRANCH_NAME=${GITHUB_REF#refs/heads/}
+      - name: Echo branch name
+        run: echo ${BRANCH_NAME}
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org/
+      - name: Install Dependencies
+        run: npm run setup
+      - name: Lint
+        run: npm run lint

.gitignore

@@ -14,7 +14,6 @@ release/
 *.swp
 *.dia~
 .ice
-.vscode
 
 npm-debug.log*
 yarn-debug.log*

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run lint

.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug Main Process",
+      "type": "node",
+      "request": "launch",
+      "cwd": "${workspaceFolder}",
+      "runtimeExecutable": "npm",
+      "args": [
+        "run",
+        "start:electron"
+      ],
+    }
+  ]
+}

LICENSE

@@ -0,0 +1,22 @@
+MIT LICENSE
+
+Copyright (c) 2018-present Alibaba Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.