feat: adds function for generating prettier ignore files and formats …

…code

.github/workflows/ci.yml

@@ -2,22 +2,22 @@ name: CI
 on:
   pull_request:
     paths-ignore:
-      - 'README.md'
+      - "README.md"
   push:
     branches:
       - master
     paths-ignore:
-      - 'README.md'
+      - "README.md"
   workflow_dispatch:
 
 jobs:
   check:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - uses: cachix/install-nix-action@v17
-    - uses: cachix/cachix-action@v10
-      with:
-        name: jmgilman
-        authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-    - run: nix develop -c just check
+      - uses: actions/checkout@v2
+      - uses: cachix/install-nix-action@v17
+      - uses: cachix/cachix-action@v10
+        with:
+          name: jmgilman
+          authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}"
+      - run: nix develop -c just check

.github/workflows/docs.yml

@@ -4,20 +4,20 @@ on:
     branches:
       - master
     paths:
-      - 'docs/**'
+      - "docs/**"
   workflow_dispatch:
 
 jobs:
   check:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - uses: cachix/install-nix-action@v17
-    - uses: cachix/cachix-action@v10
-      with:
-        name: jmgilman
-        authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-    - run: nix develop -c just check
+      - uses: actions/checkout@v2
+      - uses: cachix/install-nix-action@v17
+      - uses: cachix/cachix-action@v10
+        with:
+          name: jmgilman
+          authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}"
+      - run: nix develop -c just check
   docs:
     runs-on: ubuntu-latest
     needs: [check]
@@ -27,5 +27,5 @@ jobs:
       - uses: cachix/cachix-action@v10
         with:
           name: jmgilman
-          authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-      - run: nix develop -c just deploy
+          authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}"
+      - run: nix develop -c just deploy

.gitignore

@@ -1,4 +1,5 @@
 .direnv/
 .justfile
 .pre-commit-config.yaml
+.prettierignore
 site/

docs/contributing/design.md

@@ -26,7 +26,7 @@ the format needed for the configuration file.
 ## Plugins
 
 The main interface that Nixago provides is through its [plugin][4]
-infrastructure.  A plugin is simply a small wrapper which generates a
+infrastructure. A plugin is simply a small wrapper which generates a
 configuration file for a specific tool. The structure of plugins is consistent
 in that they ingest data from the user and produce an instance of the
 [template module](#templates). This module provides a derivation which will

docs/contributing/plugins.md

@@ -43,13 +43,13 @@ advanced cases may require multiple files. The file should be called
 When creating the CUE file, keep the following in mind:
 
 - The schema defined in the file should be sufficient enough to prevent most
-configuration mistakes.
+  configuration mistakes.
 
 - If the tool being supported has rich documentation around valid values for
-each configuration field, use constraints to improve the accuracy of the schema.
+  each configuration field, use constraints to improve the accuracy of the schema.
 
 - Don't be overly strict with the schema definition. The goal is to be helpful
-and not generate a large number of false negatives.
+  and not generate a large number of false negatives.
 
 Here is the `template.nix` file for our pre-commit plugin:
 

docs/plugins/prettier.md

@@ -22,9 +22,9 @@ Produces the following `.prettierrc.json`:
 
 ```json
 {
-    "arrowParens": "always",
-    "bracketSpacing": true,
-    "tabWidth": 80
+  "arrowParens": "always",
+  "bracketSpacing": true,
+  "tabWidth": 80
 }
 ```
 
@@ -52,17 +52,17 @@ Produces:
 
 ```json
 {
-    "arrowParens": "always",
-    "bracketSpacing": true,
-    "overrides": [
-        {
-            "files": "*.js",
-            "options": {
-                "semi": true
-            }
-        }
-    ],
-    "tabWidth": 80
+  "arrowParens": "always",
+  "bracketSpacing": true,
+  "overrides": [
+    {
+      "files": "*.js",
+      "options": {
+        "semi": true
+      }
+    }
+  ],
+  "tabWidth": 80
 }
 ```
 

flake.nix

@@ -47,6 +47,7 @@
           pkgs.mkdocs
           pkgs.nixpkgs-fmt
           pkgs.pre-commit
+          pkgs.nodePackages.prettier
         ];
 
         # Define development dependencies
@@ -58,19 +59,12 @@
 
         # Define development tool configuration
         configurations = {
-          # Pre-commit configuration
-          "pre-commit.mkLocalConfig" = {
-            nixpkgs-fmt = {
-              entry = tools.nixpkgs-fmt.exe;
-              language = "system";
-              files = "\\.nix";
-            };
-          };
           # Just configuration
           "just.mkConfig" = {
             tasks = {
               check = [
                 "@${tools.nixpkgs-fmt.exe} --check flake.nix $(git ls-files '**/*.nix')"
+                "@${tools.prettier.exe} -c ."
                 "@nix flake check"
                 "@mkdocs build --strict && rm -rf site"
               ];
@@ -79,9 +73,23 @@
               ];
               fmt = [
                 "@${tools.nixpkgs-fmt.exe} flake.nix $(git ls-files '**/*.nix')"
+                "@${tools.prettier.exe} -w ."
               ];
             };
           };
+          # Pre-commit configuration
+          "pre-commit.mkLocalConfig" = {
+            nixpkgs-fmt = {
+              entry = tools.nixpkgs-fmt.exe;
+              language = "system";
+              files = "\\.nix";
+            };
+          };
+          # Prettier
+          "prettier.mkIgnoreConfig" = [
+            ".direnv"
+            "tests"
+          ];
         };
       in
       {

mkdocs.yml

@@ -8,15 +8,15 @@ theme:
 
 nav:
   - Home: index.md
-  - 'Quick Start': quick_start.md
+  - "Quick Start": quick_start.md
   - Plugins:
-    - Overview: plugins/overview.md
-    - Just: plugins/just.md
-    - Pre-commit: plugins/pre-commit.md
-    - Prettier: plugins/prettier.md
+      - Overview: plugins/overview.md
+      - Just: plugins/just.md
+      - Pre-commit: plugins/pre-commit.md
+      - Prettier: plugins/prettier.md
   - Contributing:
-    - Design: contributing/design.md
-    - Plugins: contributing/plugins.md
+      - Design: contributing/design.md
+      - Plugins: contributing/plugins.md
 
 markdown_extensions:
   - pymdownx.highlight:
@@ -26,4 +26,4 @@ markdown_extensions:
   - pymdownx.inlinehilite
   - pymdownx.snippets:
       check_paths: true
-  - pymdownx.superfences
+  - pymdownx.superfences

plugins/prettier/default.nix

@@ -3,4 +3,5 @@
   /* Creates a .prettierrc.json file for configuring prettier.
   */
   mkConfig = import ./mkConfig.nix { inherit pkgs lib; };
+  mkIgnoreConfig = import ./mkIgnoreConfig.nix { inherit pkgs lib; };
 }

plugins/prettier/mkIgnoreConfig.nix

@@ -0,0 +1,20 @@
+{ pkgs, lib }:
+data:
+with pkgs.lib;
+let
+  files = [ ./template_ignore.cue ];
+  output = ".prettierignore";
+  flags = {
+    expression = "rendered";
+    out = "text";
+  };
+
+  # Generate the module
+  result = lib.mkTemplate {
+    inherit files output flags;
+    data = { inherit data; };
+  };
+in
+{
+  inherit (result) configFile shellHook;
+}

plugins/prettier/template_ignore.cue

@@ -0,0 +1,5 @@
+import "strings"
+
+data: [...string]
+
+rendered: strings.Join(data, "\n")