Unify file and dir names; integrate ls-lint

Signed-off-by: Oleksandr Redko <[email protected]>
norio-nomura · Jul 10, 2024 · 35ccb6a · 35ccb6a
1 parent 463ed82
commit 35ccb6a
Show file tree

Hide file tree

Showing 25 changed files with 36 additions and 0 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -46,6 +46,8 @@ jobs:
       run: |
         sudo apt-get update
         sudo apt-get install -y shellcheck
+    - name: Run file and directory name linter
+      uses: ls-lint/[email protected]
     - name: Run shellcheck
       run: find . -name '*.sh' | xargs shellcheck
     - name: Install shfmt

diff --git a/.ls-lint.yml b/.ls-lint.yml
@@ -0,0 +1,34 @@
+# ls-lint configuration file.
+# https://ls-lint.org/2.2/configuration/the-basics.html
+ls:
+  .dir: kebab-case
+  .go: snake_case
+  .lima: snake_case
+  .sh: kebab-case
+  .TEMPLATE.yaml: kebab-case
+  .yaml: kebab-case
+  .yml: kebab-case
+
+  .github:
+    .yaml: snake_case
+
+  cmd/limactl:
+    # valid names are `show-ssh.go` or `show-ssh_test.go`
+    .go: kebab-case | regex:[a-z0-9-]+_test
+
+  docs:
+    .md: kebab-case
+
+  website/content:
+    .dir: lowercase
+
+ignore:
+- .git
+- .golangci.yml
+- .ls-lint.yml
+- '_output'
+- '**/*.pb\.go'
+- hack/common.inc.sh
+- pkg/cidata/cidata.TEMPLATE.d
+- pkg/cidata/cidata.TEMPLATE.d/util/compare_version.sh
+- website
diff --git a/cmd/limactl/show_ssh.go → cmd/limactl/show-ssh.go b/cmd/limactl/show_ssh.go → cmd/limactl/show-ssh.go
diff --git a/pkg/networks/usernet/UDPFileConn.go → pkg/networks/usernet/udpfileconn.go b/pkg/networks/usernet/UDPFileConn.go → pkg/networks/usernet/udpfileconn.go
diff --git a/website/content/en/docs/Community/_index.md → website/content/en/docs/community/_index.md b/website/content/en/docs/Community/_index.md → website/content/en/docs/community/_index.md
diff --git a/.../en/docs/Community/Contributing/_index.md → .../en/docs/community/contributing/_index.md b/.../en/docs/Community/Contributing/_index.md → .../en/docs/community/contributing/_index.md
diff --git a/...nt/en/docs/Community/Governance/_index.md → ...nt/en/docs/community/governance/_index.md b/...nt/en/docs/Community/Governance/_index.md → ...nt/en/docs/community/governance/_index.md
diff --git a/...ntent/en/docs/Community/Roadmap/_index.md → ...ntent/en/docs/community/roadmap/_index.md b/...ntent/en/docs/Community/Roadmap/_index.md → ...ntent/en/docs/community/roadmap/_index.md
diff --git a/...t/en/docs/Community/Subprojects/_index.md → ...t/en/docs/community/subprojects/_index.md b/...t/en/docs/Community/Subprojects/_index.md → ...t/en/docs/community/subprojects/_index.md
diff --git a/website/content/en/docs/Config/_index.md → website/content/en/docs/config/_index.md b/website/content/en/docs/Config/_index.md → website/content/en/docs/config/_index.md
diff --git a/...te/content/en/docs/Config/Mount/_index.md → ...te/content/en/docs/config/mount/_index.md b/...te/content/en/docs/Config/Mount/_index.md → ...te/content/en/docs/config/mount/_index.md
diff --git a/...ntent/en/docs/Config/Multi-arch/_index.md → ...ntent/en/docs/config/multi-arch/_index.md b/...ntent/en/docs/Config/Multi-arch/_index.md → ...ntent/en/docs/config/multi-arch/_index.md
diff --git a/.../content/en/docs/Config/Network/_index.md → .../content/en/docs/config/network/_index.md b/.../content/en/docs/Config/Network/_index.md → .../content/en/docs/config/network/_index.md
diff --git a/...e/content/en/docs/Config/VMType/_index.md → ...e/content/en/docs/config/vmtype/_index.md b/...e/content/en/docs/Config/VMType/_index.md → ...e/content/en/docs/config/vmtype/_index.md
diff --git a/...e/content/en/docs/dev/Internals/_index.md → ...e/content/en/docs/dev/internals/_index.md b/...e/content/en/docs/dev/Internals/_index.md → ...e/content/en/docs/dev/internals/_index.md
diff --git a/...ite/content/en/docs/dev/Testing/_index.md → ...ite/content/en/docs/dev/testing/_index.md b/...ite/content/en/docs/dev/Testing/_index.md → ...ite/content/en/docs/dev/testing/_index.md
diff --git a/website/content/en/docs/Examples/_index.md → website/content/en/docs/examples/_index.md b/website/content/en/docs/Examples/_index.md → website/content/en/docs/examples/_index.md
diff --git a/...te/content/en/docs/Installation/_index.md → ...te/content/en/docs/installation/_index.md b/...te/content/en/docs/Installation/_index.md → ...te/content/en/docs/installation/_index.md
diff --git a/website/content/en/docs/Reference/_index.md → website/content/en/docs/reference/_index.md b/website/content/en/docs/Reference/_index.md → website/content/en/docs/reference/_index.md
diff --git a/website/content/en/docs/Releases/_index.md → website/content/en/docs/releases/_index.md b/website/content/en/docs/Releases/_index.md → website/content/en/docs/releases/_index.md
diff --git a/...ent/en/docs/Releases/Deprecated/_index.md → ...ent/en/docs/releases/deprecated/_index.md b/...ent/en/docs/Releases/Deprecated/_index.md → ...ent/en/docs/releases/deprecated/_index.md
diff --git a/...t/en/docs/Releases/Experimental/_index.md → ...t/en/docs/releases/experimental/_index.md b/...t/en/docs/Releases/Experimental/_index.md → ...t/en/docs/releases/experimental/_index.md
diff --git a/website/content/en/docs/Talks/_index.md → website/content/en/docs/talks/_index.md b/website/content/en/docs/Talks/_index.md → website/content/en/docs/talks/_index.md
diff --git a/website/content/en/docs/Templates/_index.md → website/content/en/docs/templates/_index.md b/website/content/en/docs/Templates/_index.md → website/content/en/docs/templates/_index.md
diff --git a/website/content/en/docs/Usage/_index.md → website/content/en/docs/usage/_index.md b/website/content/en/docs/Usage/_index.md → website/content/en/docs/usage/_index.md