Merge pull request #168 from sugarlabs/develop

Release v4.0.0

.eslintrc

@@ -0,0 +1,47 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 12,
+        "sourceType": "module"
+    },
+    "rules": {
+        "no-mixed-spaces-and-tabs": "warn",
+        "no-unused-vars": "off",
+        "@typescript-eslint/no-unused-vars": [
+            "warn",
+            {
+                "argsIgnorePattern": "^_",
+                "varsIgnorePattern": "^_"
+            }
+        ],
+        "no-use-before-define": "off",
+        "@typescript-eslint/no-use-before-define": ["error", "nofunc"],
+        "@typescript-eslint/no-non-null-assertion": "off",
+        "semi": ["error", "always"],
+        "prefer-const": ["off"],
+        "no-console": "off",
+        "max-len": [
+            "warn",
+            {
+                "code": 100,
+                "ignoreTrailingComments": true,
+                "ignoreComments": true,
+                "ignoreStrings": true,
+                "ignoreTemplateLiterals": true
+            }
+        ],
+        "no-trailing-spaces": ["warn", { "skipBlankLines": true, "ignoreComments": true }],
+        "no-duplicate-case": "error",
+        "no-irregular-whitespace": "warn"
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+        "prettier",
+        "plugin:json/recommended-with-comments"
+    ]
+}

.github/workflows/CD.yml

@@ -0,0 +1,44 @@
+---
+# Documentation:https://help.github.com/en/articles/workflow-syntax-for-github-actions
+
+name: Continuous Deployment
+
+on:
+  push:
+    branches: [develop]
+
+jobs:
+  deploy:
+    name: Build and Deploy app to GitHub Pages
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the code base
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js 16.x
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+
+      - name: Install dependencies
+        run: |
+          echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" >> .npmrc
+          npm ci
+          rm -rf .npmrc
+
+      - name: Build for Production
+        run: npm run build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build
+          force_orphan: true
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
+          full_commit_message: 'deploy: publish app to GitHub Pages'

.github/workflows/lint.yml

@@ -0,0 +1,48 @@
+---
+# Documentation: https://help.github.com/en/articles/workflow-syntax-for-github-actions
+
+name: Super-Linter
+
+on:
+  pull_request:
+    branches: [develop]
+
+jobs:
+  lint:
+    name: Lint Code Base
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the code base
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js 16.x
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+
+      - name: Install dependencies
+        run: |
+          echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" >> .npmrc
+          npm ci
+          rm -rf .npmrc
+
+      - name: Lint new and edited files
+        uses: github/super-linter/slim@v4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DEFAULT_BRANCH: develop
+          LINTER_RULES_PATH: /
+          JAVASCRIPT_ES_CONFIG_FILE: .eslintrc
+          TYPESCRIPT_ES_CONFIG_FILE: .eslintrc
+          MARKDOWN_CONFIG_FILE: .markdownlint.jsonc
+          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_CSS: false
+          VALIDATE_DOCKERFILE: false
+          VALIDATE_DOCKERFILE_HADOLINT: false
+          VALIDATE_JAVASCRIPT_STANDARD: false
+          VALIDATE_TYPESCRIPT_STANDARD: false
+          VALIDATE_JSCPD: false

.gitignore

@@ -7,8 +7,12 @@
 /coverage
 
 # production
+/dist
 /build
 
+# app config (dev)
+/src/config/*-dev.json
+
 # linter
 .eslintcache
 

.markdownlint.jsonc

@@ -37,7 +37,7 @@
   // MD007/ul-indent - Unordered list indentation
   "MD007": {
     // Spaces for indent
-    "indent": 4,
+    "indent": 2,
     // Whether to indent the first level of the list
     "start_indented": false
   },
@@ -118,7 +118,7 @@
   // MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
   "MD024": {
     // Only check sibling headings
-    "allow_different_nesting": false,
+    "allow_different_nesting": true,
     // Only check sibling headings
     "siblings_only": false
   },
@@ -246,5 +246,15 @@
   "MD048": {
     // Code fence syle
     "style": "consistent"
+  },
+
+  // MD049/emphasis-style - Emphasis style should be consistent
+  "MD049": {
+    "style": "consistent"
+  },
+
+  // MD050/strong-style - Strong style should be consistent
+  "MD050": {
+    "style": "consistent"
   }
 }

.npmrc

@@ -0,0 +1 @@
+@sugarlabs:registry=https://npm.pkg.github.com

.prettierrc

@@ -0,0 +1,20 @@
+{
+    "printWidth": 100,
+    "tabWidth": 4,
+    "useTabs": false,
+    "semi": true,
+    "singleQuote": true,
+    "quoteProps": "consistent",
+    "trailingComma": "all",
+    "bracketSpacing": true,
+    "arrowParens": "always",
+    "endOfLine": "lf",
+    "overrides": [
+        {
+            "files": ["*.json", "*.jsonc", "*.yml", "*.html", "*.css", "*.scss", "*.tsx"],
+            "options": {
+                "tabWidth": 2
+            }
+        }
+    ]
+}