Merge pull request #41 from agile-ts/develop

Develop

Author: bennobuilder

.eslintignore

@@ -0,0 +1,7 @@
+dist
+node_modules
+.eslintrc.js
+jest.config.js
+jest.config.base.js
+scripts/
+examples/

.eslintrc.js

@@ -0,0 +1,32 @@
+const OFF = 0;
+const WARNING = 1;
+const ERROR = 2;
+
+module.exports = {
+  root: true,
+  env: {
+    browser: true,
+    commonjs: true,
+    jest: true,
+    node: true,
+  },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier',
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    allowImportExportEverywhere: true,
+    ecmaVersion: 12,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint', 'prettier'],
+  rules: {
+    'func-names': OFF,
+    '@typescript-eslint/no-explicit-any': OFF,
+    '@typescript-eslint/explicit-module-boundary-types': OFF,
+    '@typescript-eslint/ban-types': WARNING,
+    '@typescript-eslint/ban-ts-comment': WARNING,
+  },
+};

.prettierignore

@@ -0,0 +1,5 @@
+dist
+node_modules
+build
+.docusaurus
+.yalc

.prettierrc

@@ -0,0 +1,13 @@
+{
+  "_comment": "To apply prettier config to Webstorm https://intellij-support.jetbrains.com/hc/en-us/community/posts/360002745119-How-to-have-Reformat-Code-feature-behave-exactly-like-Prettier-",
+  "arrowParens": "always",
+  "bracketSpacing": true,
+  "jsxBracketSameLine": true,
+  "printWidth": 80,
+  "tabWidth": 2,
+  "proseWrap": "never",
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "endOfLine": "lf",
+  "semi": true
+}

docusaurus.config.js

@@ -1,190 +1,192 @@
-const githubOrgUrl = "https://github.com/agile-ts";
-const domain = "https://agile-ts.org";
+const githubOrgUrl = 'https://github.com/agile-ts';
+const domain = 'https://agile-ts.org';
+const npmOrgUrl = 'https://www.npmjs.com/package/@agile-ts';
 
 const customFields = {
   copyright: `Created with 💜 in Germany     |    Copyright © ${new Date().getFullYear()} <a target="_blank" rel="noopener noreferrer" href="https://twitter.com/DevBenno">BennoDev</a>`,
-  description: "AgileTs is a spacy, fast, simple State Management Framework",
+  description: 'AgileTs is a spacy, fast, simple State Management Framework',
   domain,
   githubOrgUrl,
   githubUrl: `${githubOrgUrl}/agile`,
   githubDocsUrl: `${githubOrgUrl}/documentation`,
+  npmCoreUrl: `${npmOrgUrl}/core`,
   discordUrl: `https://discord.gg/T9GzreAwPH`,
-  stackoverflowUrl: "https://stackoverflow.com/questions/tagged/agile-ts",
-  twitterUrl: "https://twitter.com/AgileFramework",
-  version: "0.0.1",
+  stackoverflowUrl: 'https://stackoverflow.com/questions/tagged/agile-ts',
+  twitterUrl: 'https://twitter.com/AgileFramework',
+  version: '0.0.1',
   announcementBarContent:
     'If you like AgileTs, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/agile-ts/agile">GitHub</a> 🎉 !️',
 };
 
 const config = {
-  title: "AgileTs",
-  tagline: "AgileTs is a spacy, fast, simple State-Management Framework",
+  title: 'AgileTs',
+  tagline: 'AgileTs is a spacy, fast, simple State-Management Framework',
   url: customFields.domain,
   baseUrlIssueBanner: false,
-  baseUrl: "/",
-  onBrokenLinks: "throw",
-  favicon: "img/favicon.ico",
-  organizationName: "AgileTs",
-  projectName: "agilets",
-  themes: ["@docusaurus/theme-live-codeblock"],
+  baseUrl: '/',
+  onBrokenLinks: 'throw',
+  favicon: 'img/favicon.ico',
+  organizationName: 'AgileTs',
+  projectName: 'agilets',
+  themes: ['@docusaurus/theme-live-codeblock'],
   plugins: [
-    "docusaurus-plugin-sass" /* @docusaurus/plugin-google-analytics (Not necessary because it automatically gets added) */,
+    'docusaurus-plugin-sass' /* @docusaurus/plugin-google-analytics (Not necessary because it automatically gets added) */,
   ],
   customFields: { ...customFields },
   themeConfig: {
     hideableSidebar: true,
     algolia: {
-      apiKey: "6b7b98565bb82e16996fd185f378d618",
-      indexName: "agile-ts",
+      apiKey: '6b7b98565bb82e16996fd185f378d618',
+      indexName: 'agile-ts',
     },
     colorMode: {
-      defaultMode: "dark",
+      defaultMode: 'dark',
       disableSwitch: false,
       respectPrefersColorScheme: true,
     },
     announcementBar: {
-      id: "github-star",
+      id: 'github-star',
       content: customFields.announcementBarContent,
-      backgroundColor: "#9c9abf",
+      backgroundColor: '#9c9abf',
     },
     prism: {
-      theme: require("prism-react-renderer/themes/github"),
-      darkTheme: require("prism-react-renderer/themes/dracula"),
+      theme: require('prism-react-renderer/themes/github'),
+      darkTheme: require('prism-react-renderer/themes/dracula'),
     },
     algolia: {
-      apiKey: "6b7b98565bb82e16996fd185f378d618",
-      indexName: "agile-ts",
+      apiKey: '6b7b98565bb82e16996fd185f378d618',
+      indexName: 'agile-ts',
     },
     navbar: {
-      title: " ",
+      title: ' ',
       hideOnScroll: true,
       logo: {
-        alt: "My Site Logo",
-        src: "img/logo.svg",
+        alt: 'My Site Logo',
+        src: 'img/logo.svg',
       },
       items: [
         // left
         {
-          label: "Get Started",
-          position: "left",
+          label: 'Get Started',
+          position: 'left',
           items: [
             {
-              label: "Installation",
-              to: "/docs/installation/",
+              label: 'Installation',
+              to: '/docs/installation/',
             },
             {
-              label: "React",
-              to: "/docs/quick-start/react/",
+              label: 'React',
+              to: '/docs/quick-start/react/',
             },
             {
-              label: "Style Guide",
-              to: "/docs/style-guide/",
+              label: 'Style Guide',
+              to: '/docs/style-guide/',
             },
           ],
         },
         {
-          label: "Community",
-          position: "left",
+          label: 'Community',
+          position: 'left',
           items: [
             {
-              label: "GitHub",
+              label: 'GitHub',
               href: customFields.githubUrl,
             },
             {
-              label: "Discord",
+              label: 'Discord',
               href: customFields.discordUrl,
             },
             {
-              label: "Stack Overflow",
+              label: 'Stack Overflow',
               href: customFields.stackoverflowUrl,
             },
             {
-              label: "Twitter",
+              label: 'Twitter',
               href: customFields.twitterUrl,
             },
           ],
         },
         {
-          label: "Documentation",
-          position: "left",
-          to: "docs/introduction/",
+          label: 'Documentation',
+          position: 'left',
+          to: 'docs/introduction/',
         },
       ],
     },
     footer: {
       copyright: customFields.copyright,
-      style: "dark",
+      style: 'dark',
       copyright: customFields.copyright,
       links: [
         {
-          title: "Docs",
+          title: 'Docs',
           items: [
             {
-              label: "Get Started",
-              to: "docs/introduction",
+              label: 'Get Started',
+              to: 'docs/introduction',
             },
           ],
         },
         {
-          title: "Community",
+          title: 'Community',
           items: [
             {
-              label: "Stack Overflow",
+              label: 'Stack Overflow',
               href: customFields.stackoverflowUrl,
             },
             {
-              label: "Discord",
+              label: 'Discord',
               href: customFields.discordUrl,
             },
             {
-              label: "Twitter",
+              label: 'Twitter',
               href: customFields.twitterUrl,
             },
           ],
         },
         {
-          title: "More",
+          title: 'More',
           items: [
             {
-              label: "Blog",
-              to: "/blog/",
+              label: 'Blog',
+              to: '/blog/',
             },
             {
-              label: "GitHub",
+              label: 'GitHub',
               href: customFields.githubUrl,
             },
           ],
         },
       ],
     },
     googleAnalytics: {
-      trackingID: "UA-189394644-1",
+      trackingID: 'UA-189394644-1',
       anonymizeIP: true, // Should IPs be anonymized?
     },
   },
   presets: [
     [
-      "@docusaurus/preset-classic",
+      '@docusaurus/preset-classic',
       {
         docs: {
-          path: "docs",
+          path: 'docs',
           admonitions: {
-            icons: "emoji",
+            icons: 'emoji',
           },
-          sidebarPath: require.resolve("./sidebars.js"),
+          sidebarPath: require.resolve('./sidebars.js'),
           editUrl: `${customFields.githubDocsUrl}/tree/develop`,
           showLastUpdateAuthor: false,
           showLastUpdateTime: true,
           remarkPlugins: [
-            [require("@docusaurus/remark-plugin-npm2yarn"), { sync: true }],
+            [require('@docusaurus/remark-plugin-npm2yarn'), { sync: true }],
           ],
         },
         blog: {
           showReadingTime: true,
           editUrl: `${customFields.githubDocsUrl}/tree/develop`,
         },
         theme: {
-          customCss: [require.resolve("./src/css/custom.scss")],
+          customCss: [require.resolve('./src/css/custom.scss')],
         },
       },
     ],

package.json

@@ -10,7 +10,9 @@
     "deploy": "docusaurus deploy",
     "serve": "docusaurus serve",
     "buildserve": "yarn run build && yarn run serve",
-    "install-docusaurus": "yalc add @docusaurus/core & yarn install"
+    "install-docusaurus": "yalc add @docusaurus/core & yarn install",
+    "prettier": "prettier --config .prettierrc --write \"**/*.{js,ts}\"",
+    "lint": "eslint --cache \"**/*.{js,jsx,ts,tsx}\""
   },
   "dependencies": {
     "@agile-ts/core": "0.0.11",
@@ -39,6 +41,13 @@
     "@types/react-helmet": "^6.1.0",
     "@types/react-router-dom": "^5.1.6",
     "@types/styled-components": "^5.1.0",
+    "eslint": "^7.17.0",
+    "eslint-plugin-prettier": "^3.3.1",
+    "eslint-config-prettier": "^6.11.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-config-node": "^4.1.0",
+    "prettier": "2.1.2",
+    "ts-node": "^8.10.2",
     "typescript": "^4.1.5"
   },
   "browserslist": {