Typescript

.eslintrc.js

@@ -1,15 +1,27 @@
+const path = require('path');
+
 module.exports = {
-  extends: ['plugin:@shopify/esnext', 'plugin:@shopify/jest', 'plugin:@shopify/prettier'],
+  extends: [
+    'plugin:@shopify/typescript',
+    'plugin:@shopify/jest',
+    'plugin:@shopify/prettier',
+  ],
+  parser: '@typescript-eslint/parser',
   env: {
     browser: true,
     node: true,
   },
   rules: {
-    'import/no-unresolved': 'off',
-    'import/no-extraneous-dependencies': 'off',
-    'class-methods-use-this': 'off',
-    'line-comment-position': 0,
-    'lines-around-comment': 'off',
     'jest/valid-title': 'off',
   },
+  settings: {
+    'import/resolver': {
+      node: {
+        paths: [
+          path.resolve(__dirname, 'src'),
+          path.resolve(__dirname, 'test'),
+        ],
+      },
+    },
+  },
 };

.github/workflows/tests.yml → .github/workflows/ci.yml

@@ -25,5 +25,11 @@ jobs:
       - name: Lint
         run: yarn lint
 
+      - name: Library typecheck
+        run: yarn type-check
+
+      - name: Scripts typecheck
+        run: yarn type-check:scripts
+
       - name: Test
         run: yarn test

.prettierrc

@@ -1,7 +1 @@
-{
-  "trailingComma": "all",
-  "printWidth": 120,
-  "singleQuote": true,
-  "bracketSpacing": false,
-  "arrowParens": "always"
-}
+"@shopify/prettier-config"

.vscode/launch.json

@@ -1,21 +1,16 @@
 {
-  "version": "0.2.0",
+  "version": "1.0.0",
   "configurations": [
     {
       "type": "node",
       "request": "launch",
       "name": "Jest Tests",
-      "program": "${workspaceRoot}/node_modules/jest/bin/jest.js",
+      "program": "${workspaceRoot}/node_modules/.bin/jest",
+      "console": "integratedTerminal",
       "args": [
-          "--config",
-          "config.json",
           "-i",
           "--watchAll"
       ],
-      "internalConsoleOptions": "openOnSessionStart",
-      "outFiles": [
-          "${workspaceRoot}/dist/**/*"
-      ],
     }
   ]
 }

.vscode/settings.json

@@ -9,6 +9,9 @@
     "**/node_modules": true,
     "lib": true
   },
+  "[typescript]": {
+    "editor.formatOnSave": false,
+  },
   "editor.formatOnSave": true,
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": true

CODE_OF_CONDUCT.md

@@ -14,21 +14,21 @@ orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
+- The use of sexualized language or imagery and unwelcome sexual attention or
   advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Our Responsibilities

CONTRIBUTING.md

@@ -7,10 +7,10 @@ appreciated and encouraged.
 
 1. [Code of Conduct](#code-of-conduct)
 2. [How to contribute](#how-to-contribute)
-    1. [Creating issues](#creating-issues)
-    2. [Opening pull requests](#opening-pull-requests)
-    3. [JS Docblocks](#js-docblocks)
-4. [How to run locally](#how-to-run-locally)
+   1. [Creating issues](#creating-issues)
+   2. [Opening pull requests](#opening-pull-requests)
+   3. [JS Docblocks](#js-docblocks)
+3. [How to run locally](#how-to-run-locally)
 
 ## Code of Conduct