Check formatting in CI (#61)

This cleans up a few things regarding formatting of this repo: - Adds `format` and `format:check` npm scripts - Removes the `/examples` folder. I'm not sure what purpose that served, but it didn't seem useful. - Ignore our docs from formatting (but format them somewhat now, just not the code) - Check formatting in CI
IanVS · Apr 22, 2023 · e247e1d · e247e1d
1 parent 42aa79c
commit e247e1d
Show file tree

Hide file tree

Showing 15 changed files with 165 additions and 227 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,15 +1,18 @@
 name: ci
 on: [push, pull_request]
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node: [14.x, 16.x, 18.x]
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node }}
-      - run: yarn --frozen-lockfile
-      - run: yarn test
+    build:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                node: [14.x, 16.x, 18.x]
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actions/setup-node@v2
+              with:
+                  node-version: ${{ matrix.node }}
+            - run: yarn --frozen-lockfile
+            - name: Test
+              run: yarn test
+            - name: Check formatting
+              run: yarn format:check
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -9,62 +9,62 @@
 # the `language` matrix defined below to confirm you have the correct set of
 # supported CodeQL languages.
 #
-name: "CodeQL"
+name: 'CodeQL'
 
 on:
-  push:
-    branches: [ master ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ master ]
-  schedule:
-    - cron: '37 7 * * 0'
+    push:
+        branches: [master]
+    pull_request:
+        # The branches below must be a subset of the branches above
+        branches: [master]
+    schedule:
+        - cron: '37 7 * * 0'
 
 jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
+    analyze:
+        name: Analyze
+        runs-on: ubuntu-latest
+        permissions:
+            actions: read
+            contents: read
+            security-events: write
 
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'javascript' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+        strategy:
+            fail-fast: false
+            matrix:
+                language: ['javascript']
+                # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+                # Learn more about CodeQL language support at https://git.io/codeql-language-support
 
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v2
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+            # Initializes the CodeQL tools for scanning.
+            - name: Initialize CodeQL
+              uses: github/codeql-action/init@v1
+              with:
+                  languages: ${{ matrix.language }}
+                  # If you wish to specify custom queries, you can do so here or in a config file.
+                  # By default, queries listed here will override any specified in a config file.
+                  # Prefix the list here with "+" to use these queries and those in the config file.
+                  # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+            # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+            # If this step fails, then you should remove it and run the build manually (see below)
+            - name: Autobuild
+              uses: github/codeql-action/autobuild@v1
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+            # ℹ️ Command-line programs to run using the OS shell.
+            # 📚 https://git.io/JvXDl
 
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
+            # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+            #    and modify them (or add more) to build your code if your project
+            #    uses a compiled language
 
-    #- run: |
-    #   make bootstrap
-    #   make release
+            #- run: |
+            #   make bootstrap
+            #   make release
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+            - name: Perform CodeQL Analysis
+              uses: github/codeql-action/analyze@v1
diff --git a/.prettierignore b/.prettierignore
@@ -1,2 +1,7 @@
 tests/
 lib/
+
+# Until we can find a way to ignore codeblocks (we need before/after)
+README.md
+docs/TROUBLESHOOTING.md
+docs/MIGRATION.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -9,14 +9,14 @@ Contributions are always welcome, no matter how large or small! Before contribut
 There are different ways to contribute, each comes with a different levels
 of tasks, such as:
 
-- Report a bug.
-- Request a feature you think would be great for the plugin.
-- Take the ownership of the bug you want to fix and let others know about it by commenting on the issue.
-- Test and triage reported bugs by others.
-- Work on requested/approved features.
-- Improve the codebase (lint, naming, comments, test descriptions, etc...)
-- Improve the documentation.
-- Let the world know about the plugin!
+-   Report a bug.
+-   Request a feature you think would be great for the plugin.
+-   Take the ownership of the bug you want to fix and let others know about it by commenting on the issue.
+-   Test and triage reported bugs by others.
+-   Work on requested/approved features.
+-   Improve the codebase (lint, naming, comments, test descriptions, etc...)
+-   Improve the documentation.
+-   Let the world know about the plugin!
 
 ### Submitting a Pull Request
 
@@ -32,4 +32,4 @@ Subsequent pull requests only need to follow step 3 and beyond.
 
 **NOTE**: While there are other ways to accomplish the steps using other tools,
 the examples here will assume most actions will be performed via `git` on
-command line.
+command line.
diff --git a/README.md b/README.md
@@ -10,37 +10,37 @@ Since then more critical features & fixes have been added. As a result, this rep
 
 **Features not currently supported by upstream:**
 
-- Do not re-order across side-effect imports
-- Combine imports from the same source ([`importOrderMergeDuplicateImports`](#importordermergeduplicateimports))
-- Combine type and value imports ([`importOrderCombineTypeAndValueImports`](#importordercombinetypeandvalueimports))
-- Sort node.js builtin modules to top ([`importOrderBuiltinModulesToTop`](#importorderbuiltinmodulestotop))
-- Custom import order separation ([`importOrderSeparation`](#importorderseparation))
+-   Do not re-order across side-effect imports
+-   Combine imports from the same source ([`importOrderMergeDuplicateImports`](#importordermergeduplicateimports))
+-   Combine type and value imports ([`importOrderCombineTypeAndValueImports`](#importordercombinetypeandvalueimports))
+-   Sort node.js builtin modules to top ([`importOrderBuiltinModulesToTop`](#importorderbuiltinmodulestotop))
+-   Custom import order separation ([`importOrderSeparation`](#importorderseparation))
 
 [We welcome contributions!](./CONTRIBUTING.md)
 
 **Table of Contents**
 
-- [Sample](#sample)
-  - [Input](#input)
-  - [Output](#output)
-- [Install](#install)
-- [Usage](#usage)
-  - [How does import sort work?](#how-does-import-sort-work)
-  - [Options](#options)
-    - [`importOrder`](#importorder)
-    - [`importOrderSeparation`](#importorderseparation)
-    - [`importOrderSortSpecifiers`](#importordersortspecifiers)
-    - [`importOrderGroupNamespaceSpecifiers`](#importordergroupnamespacespecifiers)
-    - [`importOrderCaseInsensitive`](#importordercaseinsensitive)
-    - [`importOrderMergeDuplicateImports`](#importordermergeduplicateimports)
-    - [`importOrderCombineTypeAndValueImports`](#importordercombinetypeandvalueimports)
-    - [`importOrderParserPlugins`](#importorderparserplugins)
-    - [`importOrderBuiltinModulesToTop`](#importorderbuiltinmodulestotop)
-  - [Prevent imports from being sorted](#prevent-imports-from-being-sorted)
-- [FAQ / Troubleshooting](#faq--troubleshooting)
-- [Compatibility](#compatibility)
-- [Contribution](#contribution)
-- [Disclaimer](#disclaimer)
+-   [Sample](#sample)
+    -   [Input](#input)
+    -   [Output](#output)
+-   [Install](#install)
+-   [Usage](#usage)
+    -   [How does import sort work?](#how-does-import-sort-work)
+    -   [Options](#options)
+        -   [`importOrder`](#importorder)
+        -   [`importOrderSeparation`](#importorderseparation)
+        -   [`importOrderSortSpecifiers`](#importordersortspecifiers)
+        -   [`importOrderGroupNamespaceSpecifiers`](#importordergroupnamespacespecifiers)
+        -   [`importOrderCaseInsensitive`](#importordercaseinsensitive)
+        -   [`importOrderMergeDuplicateImports`](#importordermergeduplicateimports)
+        -   [`importOrderCombineTypeAndValueImports`](#importordercombinetypeandvalueimports)
+        -   [`importOrderParserPlugins`](#importorderparserplugins)
+        -   [`importOrderBuiltinModulesToTop`](#importorderbuiltinmodulestotop)
+    -   [Prevent imports from being sorted](#prevent-imports-from-being-sorted)
+-   [FAQ / Troubleshooting](#faq--troubleshooting)
+-   [Compatibility](#compatibility)
+-   [Contribution](#contribution)
+-   [Disclaimer](#disclaimer)
 
 ## Sample
 
@@ -125,20 +125,20 @@ Add your preferred settings in your prettier config file.
 
 /** @type {import("@ianvs/prettier-plugin-sort-imports").PrettierConfig} */
 module.exports = {
-  "printWidth": 80,
-  "tabWidth": 4,
-  "trailingComma": "all",
-  "singleQuote": true,
-  "semi": true,
-  "importOrder": ["^@core/(.*)$", "^@server/(.*)$", "^@ui/(.*)$", "^[./]"],
-  "importOrderBuiltinModulesToTop": true,
-  "importOrderCaseInsensitive": true,
-  "importOrderParserPlugins": ["typescript", "jsx", "decorators-legacy"],
-  "importOrderMergeDuplicateImports": true,
-  "importOrderCombineTypeAndValueImports": true,
-  "importOrderSeparation": true,
-  "importOrderSortSpecifiers": true,
-}
+    printWidth: 80,
+    tabWidth: 4,
+    trailingComma: 'all',
+    singleQuote: true,
+    semi: true,
+    importOrder: ['^@core/(.*)$', '^@server/(.*)$', '^@ui/(.*)$', '^[./]'],
+    importOrderBuiltinModulesToTop: true,
+    importOrderCaseInsensitive: true,
+    importOrderParserPlugins: ['typescript', 'jsx', 'decorators-legacy'],
+    importOrderMergeDuplicateImports: true,
+    importOrderCombineTypeAndValueImports: true,
+    importOrderSeparation: true,
+    importOrderSortSpecifiers: true,
+};
 ```
 
 _Note: all flags are off by default, so explore your options [below](#options)_
@@ -208,7 +208,7 @@ To move the third party imports at desired place, you can use `<THIRD_PARTY_MODU
 "importOrder": ["^@core/(.*)$", "<THIRD_PARTY_MODULES>", "^@server/(.*)$", "^@ui/(.*)$", "^[./]"],
 ```
 
-If you would like to order type imports differently from value imports, you can use the special `<TYPES>` string.  This example will place third party types at the top, followed by local types, then third party value imports, and lastly local value imports:
+If you would like to order type imports differently from value imports, you can use the special `<TYPES>` string. This example will place third party types at the top, followed by local types, then third party value imports, and lastly local value imports:
 
 ```json
 "importOrder": ["<TYPES>", "<TYPES>^[./]", "<THIRD_PARTY_MODULES>", "^[./]"],
@@ -245,14 +245,16 @@ _Note:_ If you want greater control over which groups are separated from others,
 
 **default value:** `false`
 
-A boolean value to enable or disable sorting of the specifiers in an import declarations.  If enabled, type imports will be sorted after value imports.
+A boolean value to enable or disable sorting of the specifiers in an import declarations. If enabled, type imports will be sorted after value imports.
 
 Before:
+
 ```ts
 import Default, {type Bravo, delta as echo, charlie, type Alpha} from 'source';
 ```
 
 After:
+
 ```ts
 import Default, {charlie, delta as echo, type Alpha, type Bravo} from 'source';
 ```
@@ -380,14 +382,14 @@ Having some trouble or an issue? You can check [FAQ / Troubleshooting section](.
 
 ## Compatibility
 
-| Framework              | Supported                | Note                                             |
-| ---------------------- | ------------------------ | ------------------------------------------------ |
-| JS with ES Modules     | ✅ Everything            | -                                                |
-| NodeJS with ES Modules | ✅ Everything            | -                                                |
-| React                  | ✅ Everything            | -                                                |
-| Angular                | ✅ Everything            | Supported through `importOrderParserPlugins` API |
-| Vue                    | ✅ Everything            | Peer dependency `@vue/compiler-sfc` is required  |
-| Svelte                 | ⚠️ Not yet                | Contributions are welcome                        |
+| Framework              | Supported     | Note                                             |
+| ---------------------- | ------------- | ------------------------------------------------ |
+| JS with ES Modules     | ✅ Everything | -                                                |
+| NodeJS with ES Modules | ✅ Everything | -                                                |
+| React                  | ✅ Everything | -                                                |
+| Angular                | ✅ Everything | Supported through `importOrderParserPlugins` API |
+| Vue                    | ✅ Everything | Peer dependency `@vue/compiler-sfc` is required  |
+| Svelte                 | ⚠️ Not yet    | Contributions are welcome                        |
 
 ## Contribution