refactor: lint with statix

styx-static · Oct 17, 2022 · 61df29f · 61df29f
1 parent 5cb1c6c
commit 61df29f
Show file tree

Hide file tree

Showing 42 changed files with 114 additions and 112 deletions.
diff --git a/docs/library-generated.adoc b/docs/library-generated.adoc
@@ -206,8 +206,8 @@ asciidocToHtml "Hello `asciidoc`!"
 
 :sectnums!:
 
-[[lib.data.groupBy]]
-=== groupBy
+[[lib.data.groupByFlatten]]
+=== groupByFlatten
 
 ==== Description
 
@@ -238,7 +238,7 @@ A property list of grouped attribute sets
 [source, nix]
 .Code
 ----
-groupBy [
+groupByFlatten [
   { type = "fruit"; name = "apple"; }
   { type = "fruit"; name = "pear"; }
   { type = "vegetable"; name = "lettuce"; }

diff --git a/src/_automation/devshells.nix b/src/_automation/devshells.nix
@@ -35,6 +35,10 @@ in
           category = "dev";
           package = nixpkgs.asciidoctor;
         }
+        {
+          category = "dev";
+          package = nixpkgs.statix;
+        }
       ];
       imports = [];
     };

diff --git a/src/_automation/libtests.nix b/src/_automation/libtests.nix
@@ -17,9 +17,7 @@ let
   root = styxlib.conf.parseDecls {
     inherit decls;
     optionFn = o:
-      if o ? default
-      then o.default
-      else null;
+      o.default or null;
   };
 
   secondStageStyxlib = styxlib.hydrate (_: _: {config = root;});
@@ -125,7 +123,8 @@ in rec {
       then extract
       else {})
     functions;
-  in (l.filter (x: x != {}) (l.flatten ex) ++ customTests);
+  in
+    l.filter (x: x != {}) (l.flatten ex) ++ customTests;
 
   missingTests = let
     missing = l.mapAttrsToList (name: fn: let

diff --git a/src/_automation/tasks.nix b/src/_automation/tasks.nix
@@ -25,6 +25,14 @@ in {
     '';
   in
     nixpkgs.writeScriptBin "run-tests" ''
+      echo ""
+      echo "------------------------------------------------"
+      echo ""
+      echo "\e[1;93mCode Linting:\e[0m"
+      echo ""
+
+      ${l.getExe nixpkgs.statix} check
+
       echo ""
       echo "------------------------------------------------"
       echo ""
@@ -63,7 +71,7 @@ in {
       echo "Finished"
     '';
   update-doc = let
-    site = {...}: rec {
+    site = _: rec {
       loaded =
         (import inputs.self {
           pkgs = nixpkgs;

diff --git a/src/data/styxthemes/agency/example/site.nix b/src/data/styxthemes/agency/example/site.nix
@@ -92,7 +92,7 @@
       title = "Home";
       path = "/index.html";
       template = templates.block-page.full;
-      layout = templates.layout;
+      inherit (templates) layout;
       blocks = let
         darken = d: d // {class = "bg-light-gray";};
       in
@@ -118,7 +118,7 @@
   # converting pages attribute set to a list
   pageList = lib.generation.pagesToList {
     inherit pages;
-    default = {layout = templates.layout;};
+    default = {inherit (templates) layout;};
   };
 
   site = lib.generation.mkSite {inherit files pageList;};

diff --git a/src/data/styxthemes/agency/meta.nix b/src/data/styxthemes/agency/meta.nix
@@ -3,8 +3,8 @@ with lib.lib; {
   name = "Agency";
   id = "agency";
   license = licenses.asl20;
-  demoPage = https://styx-static.github.io/styx-theme-agency;
-  homepage = https://github.com/styx-static/styx-theme-agency;
+  demoPage = "https://styx-static.github.io/styx-theme-agency";
+  homepage = "https://github.com/styx-static/styx-theme-agency";
   screenshot = ./screen.png;
   documentation = readFile ./documentation.adoc;
   description = ''

diff --git a/src/data/styxthemes/generic-templates/example/site.nix b/src/data/styxthemes/generic-templates/example/site.nix
@@ -60,7 +60,7 @@
 
   pages = rec {
     basic = {
-      layout = templates.layout;
+      inherit (templates) layout;
       template = templates.examples.basic;
       path = "/basic.html";
       # example of adding extra css / js to a page
@@ -71,15 +71,15 @@
     };
 
     starter = {
-      layout = templates.layout;
+      inherit (templates) layout;
       template = templates.examples.starter;
       path = "/starter.html";
       title = "Starter Template for Bootstrap";
       navbarTitle = "Starter";
     };
 
     theme = {
-      layout = templates.layout;
+      inherit (templates) layout;
       template = templates.examples.theme;
       path = "/index.html";
       title = "Theme Template for Bootstrap";

diff --git a/src/data/styxthemes/generic-templates/meta.nix b/src/data/styxthemes/generic-templates/meta.nix
@@ -4,8 +4,8 @@ with lib.lib; {
   name = "Generic templates";
   license = licenses.mit;
   maintainers = with maintainers; [ericsagnes];
-  demoPage = https://styx-static.github.io/styx-theme-generic-templates;
-  homepage = https://github.com/styx-static/styx-theme-generic-templates;
+  demoPage = "https://styx-static.github.io/styx-theme-generic-templates";
+  homepage = "https://github.com/styx-static/styx-theme-generic-templates";
   tags = ["generic-templates"];
   screenshot = ./screen.png;
   documentation = readFile ./documentation.adoc;

diff --git a/src/data/styxthemes/generic-templates/templates/lib/css/bootstrap.nix b/src/data/styxthemes/generic-templates/templates/lib/css/bootstrap.nix
@@ -8,7 +8,7 @@ env: let
     with lib.lib; let
       cnf = conf.theme.lib.bootstrap;
     in
-      optionalString (cnf.enable == true)
+      optionalString cnf.enable
       (templates.tag.link-css {href = "//maxcdn.bootstrapcdn.com/bootstrap/${cnf.version}/css/bootstrap.min.css";});
 in
   env.lib.template.documentedTemplate {

diff --git a/src/data/styxthemes/generic-templates/templates/lib/css/font-awesome.nix b/src/data/styxthemes/generic-templates/templates/lib/css/font-awesome.nix
@@ -8,7 +8,7 @@ env: let
     with lib.lib; let
       cnf = conf.theme.lib.font-awesome;
     in
-      optionalString (cnf.enable == true)
+      optionalString cnf.enable
       (templates.tag.link-css {href = "//maxcdn.bootstrapcdn.com/font-awesome/${cnf.version}/css/font-awesome.min.css";});
 in
   env.lib.template.documentedTemplate {

diff --git a/src/data/styxthemes/generic-templates/templates/lib/css/highlightjs.nix b/src/data/styxthemes/generic-templates/templates/lib/css/highlightjs.nix
@@ -8,7 +8,7 @@ env: let
     with lib.lib; let
       cnf = conf.theme.lib.highlightjs;
     in
-      optionalString (cnf.enable == true)
+      optionalString cnf.enable
       (templates.tag.link-css {href = "//cdnjs.cloudflare.com/ajax/libs/highlight.js/${cnf.version}/styles/${cnf.style}.min.css";});
 in
   env.lib.template.documentedTemplate {

diff --git a/src/data/styxthemes/generic-templates/templates/lib/js/bootstrap.nix b/src/data/styxthemes/generic-templates/templates/lib/js/bootstrap.nix
@@ -8,7 +8,7 @@ env: let
     with lib.lib; let
       cnf = conf.theme.lib.bootstrap;
     in
-      optionalString (cnf.enable == true)
+      optionalString cnf.enable
       (templates.tag.script {
         src = "//maxcdn.bootstrapcdn.com/bootstrap/${cnf.version}/js/bootstrap.min.js";
         crossorigin = "anonymous";

diff --git a/src/data/styxthemes/generic-templates/templates/lib/js/highlightjs.nix b/src/data/styxthemes/generic-templates/templates/lib/js/highlightjs.nix
@@ -8,7 +8,7 @@ env: let
     with lib.lib; let
       cnf = conf.theme.lib.highlightjs;
     in
-      optionalString (cnf.enable == true)
+      optionalString cnf.enable
       ((templates.tag.script {
           src = "//cdnjs.cloudflare.com/ajax/libs/highlight.js/${cnf.version}/highlight.min.js";
           crossorigin = "anonymous";

diff --git a/src/data/styxthemes/generic-templates/templates/lib/js/jquery.nix b/src/data/styxthemes/generic-templates/templates/lib/js/jquery.nix
@@ -11,7 +11,7 @@ env: let
     with lib.lib; let
       cnf = conf.theme.lib.jquery;
     in
-      optionalString (cnf.enable == true)
+      optionalString cnf.enable
       (templates.tag.script {
         src = "//code.jquery.com/jquery-${cnf.version}.min.js";
         crossorigin = "anonymous";

diff --git a/src/data/styxthemes/generic-templates/templates/lib/js/mathjax.nix b/src/data/styxthemes/generic-templates/templates/lib/js/mathjax.nix
@@ -8,7 +8,7 @@ env: let
     with lib.lib; let
       cnf = conf.theme.lib.mathjax;
     in
-      optionalString (cnf.enable == true)
+      optionalString cnf.enable
       (templates.tag.script {
         src = "//cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML";
         crossorigin = "anonymous";

diff --git a/src/data/styxthemes/generic-templates/templates/partials/head/title-pre.nix b/src/data/styxthemes/generic-templates/templates/partials/head/title-pre.nix
@@ -1,5 +1,5 @@
 env: let
-  template = {templates, ...}: args: templates.partials.head.meta args;
+  template = {templates, ...}: templates.partials.head.meta;
 in
   env.lib.template.documentedTemplate {
     description = ''

diff --git a/src/data/styxthemes/generic-templates/templates/partials/html.nix b/src/data/styxthemes/generic-templates/templates/partials/html.nix
@@ -8,11 +8,12 @@ env: let
   }: args:
     with lib.lib; let
       lang =
-        if html ? lang
-        then html.lang
-        else if hasAttrByPath ["html" "lang"] conf.theme
-        then conf.theme.html.lang
-        else "en";
+        html.lang
+        or (
+          if hasAttrByPath ["html" "lang"] conf.theme
+          then conf.theme.html.lang
+          else "en"
+        );
     in ''      <html ${lib.template.htmlAttr "lang" lang}>
         ${
         (templates.partials.head.default args)

diff --git a/src/data/styxthemes/generic-templates/templates/services/disqus.nix b/src/data/styxthemes/generic-templates/templates/services/disqus.nix
@@ -7,11 +7,12 @@ env: let
   }: page:
     with lib.lib; let
       id =
-        if page ? disqusID
-        then page.disqusID
-        else if page ? rootPage
-        then page.rootPage.path
-        else page.path;
+        page.disqusID
+        or (
+          if page ? rootPage
+          then page.rootPage.path
+          else page.path
+        );
       cnf = conf.theme.services.disqus;
     in
       optionalString (cnf.shortname != null)

diff --git a/src/data/styxthemes/ghostwriter/example/site.nix b/src/data/styxthemes/ghostwriter/example/site.nix
@@ -87,7 +87,7 @@
     index = mkSplit {
       title = "Home";
       basePath = "/index";
-      itemsPerPage = conf.theme.itemsPerPage;
+      inherit (conf.theme) itemsPerPage;
       template = templates.index;
       data = posts.list;
     };
@@ -115,7 +115,7 @@
       pathPrefix = "/posts/";
       template = templates.post.full;
       # Attach the author to every blog post
-      author = data.author;
+      inherit (data) author;
     };
   };
 
@@ -131,7 +131,7 @@
   */
   pageList = lib.generation.pagesToList {
     inherit pages;
-    default = {layout = templates.layout;};
+    default = {inherit (templates) layout;};
   };
 
   /*

diff --git a/src/data/styxthemes/ghostwriter/meta.nix b/src/data/styxthemes/ghostwriter/meta.nix
@@ -3,8 +3,8 @@ with lib.lib; {
   id = "ghostwriter";
   name = "Ghostwriter";
   license = licenses.mit;
-  demoPage = https://styx-static.github.io/styx-theme-ghostwriter;
-  homepage = https://github.com/styx-static/styx-theme-ghostwriter;
+  demoPage = "https://styx-static.github.io/styx-theme-ghostwriter";
+  homepage = "https://github.com/styx-static/styx-theme-ghostwriter";
   tags = ["blog"];
   documentation = readFile ./documentation.adoc;
   screenshot = ./screen.png;

diff --git a/src/data/styxthemes/ghostwriter/templates/partials/content-pre.nix b/src/data/styxthemes/ghostwriter/templates/partials/content-pre.nix
@@ -68,13 +68,13 @@ with lib.lib; ''
 
   </div>
 
-  ${optionalString ((data ? menu) && (isList data.menu) && (length (data.menu) > 0)) ''
+  ${optionalString ((data ? menu) && (isList data.menu) && (length data.menu > 0)) ''
     <ul class="site-nav">
     ${lib.template.mapTemplate (menu: ''
         <li class="site-nav-item">${templates.tag.ilink {
           to = menu;
           content = menu.title;
-          title = menu.title;
+          inherit (menu) title;
         }}</li>
       '')
       data.menu}

diff --git a/src/data/styxthemes/hyde/example/site.nix b/src/data/styxthemes/hyde/example/site.nix
@@ -83,7 +83,7 @@
     index = mkSplit {
       title = "Home";
       basePath = "/index";
-      itemsPerPage = conf.theme.itemsPerPage;
+      inherit (conf.theme) itemsPerPage;
       template = templates.index;
       data = posts.list;
     };
@@ -139,7 +139,7 @@
   # converting pages attribute set to a list
   pageList = lib.generation.pagesToList {
     inherit pages;
-    default = {layout = templates.layout;};
+    default = {inherit (templates) layout;};
   };
 
   site = lib.generation.mkSite {inherit files pageList;};

diff --git a/src/data/styxthemes/hyde/meta.nix b/src/data/styxthemes/hyde/meta.nix
@@ -3,8 +3,8 @@ with lib.lib; {
   id = "hyde";
   name = "Hyde";
   license = licenses.mit;
-  demoPage = https://styx-static.github.io/styx-theme-hyde;
-  homepage = https://github.com/styx-static/styx-theme-hyde;
+  demoPage = "https://styx-static.github.io/styx-theme-hyde";
+  homepage = "https://github.com/styx-static/styx-theme-hyde";
   tags = ["blog"];
   screenshot = ./screen.png;
   description = ''

diff --git a/src/data/styxthemes/hyde/templates/partials/body.nix b/src/data/styxthemes/hyde/templates/partials/body.nix
@@ -7,7 +7,7 @@
 with lib.lib; let
   class = lib.template.htmlAttr "class" (
     (optional (conf.theme.colorScheme != null) "theme-base-${conf.theme.colorScheme}")
-    ++ (optional (conf.theme.layout.reverse) "layout-reverse")
+    ++ (optional conf.theme.layout.reverse "layout-reverse")
   );
 in ''
   <body ${class}>

diff --git a/src/data/styxthemes/nix/example/site.nix b/src/data/styxthemes/nix/example/site.nix
@@ -157,7 +157,7 @@
   # converting pages attribute set to a list
   pageList = lib.generation.pagesToList {
     inherit pages;
-    default = {layout = templates.layout;};
+    default = {inherit (templates) layout;};
   };
 
   site = lib.generation.mkSite {

diff --git a/src/data/styxthemes/nix/meta.nix b/src/data/styxthemes/nix/meta.nix
@@ -3,8 +3,8 @@ with lib.lib; {
   id = "nix";
   name = "Nix";
   license = licenses.mit;
-  demoPage = https://styx-static.github.io/styx-theme-nix;
-  homepage = https://github.com/styx-static/styx-theme-nix;
+  demoPage = "https://styx-static.github.io/styx-theme-nix";
+  homepage = "https://github.com/styx-static/styx-theme-nix";
   tags = ["minimal"];
   screenshot = ./screen.png;
   description = ''

diff --git a/src/data/styxthemes/orbit/example/conf.nix b/src/data/styxthemes/orbit/example/conf.nix
@@ -71,7 +71,7 @@ with lib.lib; {
     summary = {
       icon = "user";
       title = "Career Profile";
-      content = (lib.data.loadFile {file = ./data/summary.md;}).content;
+      inherit ((lib.data.loadFile {file = ./data/summary.md;})) content;
     };
 
     /*

diff --git a/src/data/styxthemes/orbit/example/site.nix b/src/data/styxthemes/orbit/example/site.nix
@@ -63,7 +63,7 @@
       title = "Home";
       path = "/index.html";
       template = templates.block-page.full;
-      layout = templates.layout;
+      inherit (templates) layout;
       blocks = [
         (templates.blocks.summary conf.theme.summary)
         (templates.blocks.experiences conf.theme.experiences)

diff --git a/src/data/styxthemes/orbit/meta.nix b/src/data/styxthemes/orbit/meta.nix
@@ -3,8 +3,8 @@ with lib.lib; {
   id = "orbit";
   name = "Orbit";
   license = licenses.cc-by-30;
-  demoPage = https://styx-static.github.io/styx-theme-orbit;
-  homepage = https://github.com/styx-static/styx-theme-orbit;
+  demoPage = "https://styx-static.github.io/styx-theme-orbit";
+  homepage = "https://github.com/styx-static/styx-theme-orbit";
   tags = ["resume"];
   screenshot = ./screen.png;
   description = ''