EPICLab · kberba · Feb 4, 2019 · Mar 16, 2019 · Mar 20, 2019 · Mar 20, 2019
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,8 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = false
+insert_final_newline = false
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,5 @@
+# ignore all project config files
+*.config.js
+
+# ignore all webpack config files
+webpack.*.js
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,88 @@
+module.exports = {
+  env: {
+    node: true,
+    es2017: true,
+    jest: true
+  },
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 2017,
+    sourceType: "module",
+    jsx: true,
+    ecmaFeatures: {
+      jsx: true
+    },
+    useJSXTextNode: true,
+    project: './tsconfig.json'
+  },
+  plugins: [
+    "@typescript-eslint",
+    "react",
+    "react-hooks",
+    "jest"
+  ],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:react/recommended",
+    "plugin:jest/recommended",
+    "plugin:jest/style",
+    "plugin:import/errors",
+    "plugin:import/warnings",
+    "plugin:import/typescript"
+  ],
+  settings: {
+    "import/core-modules": ["electron"], // https://github.com/benmosher/eslint-plugin-import/blob/master/README.md#importcore-modules
+    "import/resolver": { // https://github.com/benmosher/eslint-plugin-import#resolvers
+      node: {
+        extensions: [".js", ".jsx", ".ts", ".d.ts", ".tsx"]
+      }
+    },
+    "import/ignore": [".scss", ".less", ".css"], // eslint-plugin-import can't parse unprocessed CSS modules
+    "import/no-unresolved": {
+      ignore: ["\.scss$", "\.less$", "\.css$"] // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-unresolved.md#ignore
+    }
+    ,
+    react: {
+      pragma: "React",
+      version: "detect"
+    }
+  },
+  rules: {
+    /**
+     * @description Rules of @eslint
+     */
+    // "max-len": ["error", {
+    //   "code": 120,
+    //   "tabWidth": 2,
+    //   "comments": 120,
+    //   "ignoreTrailingComments": true
+    // }],
+
+    /**
+     * @description Rules of @typescript-eslint
+     */
+    "@typescript-eslint/explicit-function-return-type": "off",
+
+    /**
+     * @description Rules of eslint-plugin-react
+     */
+    "react/prop-types": [0], // disabled checks for PropTypes blocks: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prop-types.md
+    "react/jsx-filename-extension": ["warn", {
+      "extensions": [".jsx", ".tsx"]
+    }],
+
+    /**
+     * @description Rules of eslint-plugin-react-hooks
+     */
+    "react-hooks/rules-of-hooks": "error", // enforces adherence to the Rules of Hooks: https://reactjs.org/docs/hooks-rules.html
+    "react-hooks/exhaustive-deps": "warn", // described in this thread: https://github.com/facebook/react/issues/14920
+
+    /**
+     * @description Rules of eslint-plugin-jest
+     */
+    "jest/no-disabled-tests": "warn",
+    "jest/no-mocks-import": "off"
+  }
+}
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,55 @@
+# Contributing Code
+
+All Synectic development should occur on purpose-specific branches that originate from the `development` branch, and when finished are submitted back to `development` through a pull request. The specific infrastructure and dependencies included in Synectic, along with descriptions of why each component is included and how it is configured, are found in the [DESIGN](DESIGN.md) document.
+
+## Versioning
+
+Synectic adheres to the [Semantic Versioning 2.0.0](https://semver.org/) standard (also known as `SemVer`), which states that:
+```
+Given a version number MAJOR.MINOR.PATCH, increment the:
+  1. MAJOR version when you make incompatible API changes,
+  2. MINOR version when you add functionality in a backwards compatible manner, and
+  3. PATCH version when you make backwards compatible bug fixes.
+```
+When contributing a pull request to `development`, please select all version changes that are warranted based upon your proposed changes.
+
+## Recommended Development Workflow
+
+The following steps represent the preferred development workflow, and include details about contribution requirements:
+
+1. Create a branch from `development` which has a name using either the `fix/` or `feature/` prefix followed by a brief descriptor (e.g. `fix/signin-issue` or `feature/file-explorer-card`). If your branch name includes multiple items, this is a strong indicator that they should be split into multiple branches and developed separately.
+
+2. Develop code and commit to your branch using commit messages that provide a brief context for the underlying changes (e.g. *"adds enable/disable boolean parameter to draggable function"* or *"fixes infinite loop in Card initialization"*). Wherever possible, avoid adding [platform dependent code](http://flight-manual.atom.io/hacking-atom/sections/cross-platform-compatibility/).
+
+3. Add additional [Jest](https://jestjs.io/) and [Enzyme](https://airbnb.io/enzyme/) tests to the `__test__` directory for any new or modified functionality within Synectic. Pull requests will not be submitted with failing or missing tests.
+
+4. Verify JavaScript, TypeScript, and React code meets the project standards for readability, maintainability, and no functionality errors according to [ESLint]([ESLint](https://eslint.org/)) (`yarn lint`).
+
+5. When code is complete, submit a pull request to the `development` branch. Use the *PULL_REQUEST_TEMPLATE* to provide the necessary descriptions for your PR, and link all related GitHub issues to the PR by using the *"This PR resolves #[XXXX], ..."* line to include the issue numbers (GitHub automatically adds the appropriate URLs for each issue).
+
+6. The new PR will automatically trigger a [Travis-CI](https://travis-ci.org/nelsonni/synectic) build to verify that the code included in your PR will compile, passes all tests and linting rules, and will properly build MacOS, Linux, and Windows application distribution packages. Any issues in the CI build must be fixed within your branch and pushed to GitHub so that a new CI build can be triggered.
+
+7. Once your PR has passed all tests and checks included in the CI build system, you will need to receive at least one code review and approval from a lead project maintainer. You can request code reviews from project members within the GitHub pull request interface (["Requesting a pull request review"](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review)). This process can require multiple rounds of comments and change requests from the reviewers.
+
+8. Any merge conflicts that arise between your PR and `development` must be fixed within your branch. This can occur when your PR becomes stale (i.e. new commits that conflict with your code are added to the `development` branch after you created your PR). Unfortunately, this is a common downside of distribution version control (["Pull Requests: The Good, The Bad and The Ugly"](http://allyouneedisbackend.com/blog/2017/08/24/pull-requests-good-bad-and-ugly/)). You will need to refactor your code so that any merge conflicts are resolved, and new or modificed functionality is incorporated with your changes.
+
+9. If all requirements listed above are met, then your PR should automatically merge into the `development` branch. The commits included in your PR will be squashed into a single commit that uses your PR description as the commit message, and further development on the branch used for that PR should be halted (a new branch with an appropriate branch name should be created instead).
+
+# Recommended Developer References
+
+Several sections of the Synectic API include advanced TypeScript and React features and the codebase can be difficult to understand for a newcomer, therefore the following references are compiled here for reading as needed:
+
+* [TypeScript Deep Dive: Iterators](https://basarat.gitbooks.io/typescript/docs/iterators.html)
+* [Simplify your JavaScript - Use `.map()`, `.reduce()`, and `.filter()`](https://medium.com/poka-techblog/simplify-your-javascript-use-map-reduce-and-filter-bd02c593cc2d)
+* [Using `Async/Await` with Typescript Classes](http://ivanbatic.com/using-async-await-typescript-classes/)
+* [Keep Your Promises in TypeScript using `async/await`](https://blog.bitsrc.io/keep-your-promises-in-typescript-using-async-await-7bdc57041308)
+* [Asynchronous Processing with TypeScript and Generic Promises](https://visualstudiomagazine.com/articles/2015/03/01/asynchronous-processing.aspx)
+* [TypeScript 2.1: `keyof` and Lookup Types](https://mariusschulz.com/blog/typescript-2-1-keyof-and-lookup-types)
+* [YouTube: React Today and Tomorrow and 90% Cleaner React With Hooks](https://www.youtube.com/watch?v=dpw9EHDh2bM)
+* [React: Refs and the DOM](https://reactjs.org/docs/refs-and-the-dom.html)
+* [React: Building Your Own Hooks](https://reactjs.org/docs/hooks-custom.html)
+* [React Higher-Order Components in TypeScript](https://medium.com/@jrwebdev/react-higher-order-component-patterns-in-typescript-42278f7590fb)
+* [Unit Testing using Jest with TypeScript](https://basarat.gitbooks.io/typescript/docs/testing/jest.html)
+* [Testing TypeScript with Jest](https://rjzaworski.com/2016/12/testing-typescript-with-jest)
+* [Tutorial: TypeScript, React, and Redux](https://rjzaworski.com/2016/08/typescript-redux-and-react)
+* [Testing React Components: Complete Guide](https://www.freecodecamp.org/news/testing-react-hooks/)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,25 @@
+### **Description**:
+
+*[Briefly describe the overall purpose of the included changes and their effect on the overall project.]*
+
+This PR resolves #*[XXXX]*, and signifies the following version changes:
+* [ ] MAJOR version increase
+* [ ] MINOR version increase
+* [ ] PATCH version increase
+
+### **Changes**:
+
+This PR makes the following changes:
+* *[Provide a brief descriptive statement for each change, e.g. "Adds `react-hooks/rules-of-hooks` to ESLint for verifying React Rule of Hooks"]*
+* *[Include as many descriptive statements as necessary to describe all proposed changes]*
+
+### **Checklist**:
+
+Before submitting this PR, I have verified that my code:
+* [ ] Resides on a `fix/` or `feature/` branch that was initially branched off from `development`.
+* [ ] Passes code linting (`yarn lint`) and unit testing (`yarn test`).
+* [ ] Successfully builds a distribution package (`yarn package`).
+
+Additionally, I have verified that:
+* [ ] My name is listed in the [Contributors](README.md#contributors) section, or this PR includes a request to add my name.
+* [ ] I have read and am aware of the [CONTRIBUTING](CONTRIBUTING.md) guide for this project.
diff --git a/.gitignore b/.gitignore
@@ -1,46 +1,46 @@
-# Mac-specific file metadata
+# OSX
 .DS_Store
 
-# Logs
-logs
-*.log
-npm-debug.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for project files generated by IntelliJ Platform tools
-.idea/
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules
-jspm_packages
-
-# Optional npm cache directory
-.npm
-
-# Optional REPL history
-.node_repl_history
-
-# Temporary JavaScript builds
-dist
+# Xcode
+build/
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata
+*.xccheckout
+*.moved-aside
+DerivedData
+*.hmap
+*.ipa
+*.xcuserstate
+xcshareddata
+
+# Android/IntelliJ
+build/
+.idea
+.gradle
+local.properties
+*.iml
+
+# node.js
+node_modules/
+npm-debug.log
+yarn-error.log
+
+# Bundle artifact
+*.jsbundle
+
+# Electron-Forge
+.webpack
+out/
+
+# CSS-Modules-Typescript-Loader
+*.css.d.ts
+
+# Jest code coverage
+coverage/
diff --git a/.travis.yml b/.travis.yml
@@ -1,22 +1,45 @@
 language: node_js
 node_js:
   - node
-  - 8
+  - 10
 os:
-  - osx
   - linux
+  - osx
+  - windows
+jobs:
+  allow_failures:
+    - os: linux
+    - os: windows
+dist: xenial
+osx_image: xcode11.3
 env:
   - TARGET_ARCH=x64
+
+cache:
+  npm: true
+  directories:
+  - $HOME/.cache/electron
+
+addons:
+  apt:
+    packages:
+    - fakeroot
+    - rpm
+
+# restrict Travis-CI builds to specific branches only
+# branches:
+#   only:
+#   - master
+#   - /^v\d+\.\d+\.\d+/
+
 before_install:
   - export DISPLAY=:99.0
   - Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
 install:
-  - npm install --no-progress
+- yarn install
+- yarn upgrade
+
 script:
-  - npm test
-branches:
-  only:
-    - master
-    - development
-notifications:
-  email: false
+- yarn lint
+- if test -z "$TRAVIS_TAG"; then yarn make; fi
+after_success: if test -n "$TRAVIS_TAG"; then yarn publish; fi
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,26 @@
+{
+  "editor.formatOnSave": true,
+  "eslint.autoFixOnSave": true,
+  "eslint.validate": [
+    {
+      "language": "javascript",
+      "autoFix": true
+    },
+    {
+      "language": "javascriptreact",
+      "autoFix": true
+    },
+    {
+      "language": "typescript",
+      "autoFix": true
+    },
+    {
+      "language": "typescriptreact",
+      "autoFix": true
+    }
+  ],
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  }
+}