docs: separate coverage from readme

Author: colombos

.doc/resource-coverage/coverage.md

@@ -0,0 +1,7 @@
+# Coverage
+
+___COVERAGE_PLACEHOLDER___
+
+## List
+
+___LIST_PLACEHOLDER___

.github/scripts/generate-coverage.nu

@@ -0,0 +1,37 @@
+use /home/runner/work/nuke/nuke/fmt/mod.nu
+
+let res = open .github/kube-resources/resources.yaml
+| where {'get' in ($in.verbs? | default [])}
+
+let formatters = mod supported-formatters
+let unwilling_to_support = open .github/kube-resources/unwilling_to_support.yaml
+
+let coverage = $res | group-by group --to-table | each {|group|
+  let total = $group.items | length
+  let supported_formatters = $formatters | where {|formatter| $formatter in $group.items.singularName}
+  let supported_number = $supported_formatters | length
+  let not_yet_supported_number = $total - $supported_number
+  let unwilling_to_support_formatters = $unwilling_to_support | where {|formatter| $formatter in $group.items.singularName}
+  let unwilling_to_support_number = $unwilling_to_support_formatters | length
+
+  let graph = open -r .github/templates/readme/resource-coverage.mmd
+  | str replace ___SUPPORTED___ ($supported_number | into string)
+  | str replace ___UNSUPPORTED___ ($not_yet_supported_number | into string)
+  | str replace ___UNWILLING___ ($unwilling_to_support_number | into string)
+
+  let list = $group.items | each {|item|
+    if ($item.names | any {$in in $supported_formatters}) {
+      $"| ($item.name)     | 🟢     |"
+    } else if ($item.names | any {$in in $unwilling_to_support_formatters}) {
+      $"| ($item.name)     | 🔴    |"
+    } else {
+      $"| ($item.name)     | ⚪     |"
+    }
+  } | str join "\n"
+
+
+  $"### ($group.group)\n\n($graph)\n\n($list)"
+}
+
+$"# Coverage\n\n($coverage)"
+| save -f .doc/resource-coverage/coverage.md 

.github/scripts/generate-readme.nu

@@ -7,8 +7,7 @@ A Nushell-native kubernetes toolkit
 
 ---
 
-**Nuke** natively brings Kubernetes resource inspection to [Nushell](https://www.nushell.sh/).  
-It exposes kubectl-like commands that query the Kubernetes API-Server and return results the Nushell way.
+**Nuke** natively brings Kubernetes resource inspection to Nushell: it exposes kubectl-like commands that query the Kubernetes API-Server and return results the Nushell way.
 
 Nuke **aims** to return data that is structured, queryable and typed, enabling you to execute commands like
 ```nu

.github/templates/readme/readme.md

@@ -6,10 +6,9 @@ on:
       - main
     paths:
       - ".github/workflows/readme.yml"
-      - ".github/templates/readme/*"
-      - ".github/scripts/generate-readme.nu"
+      - ".github/scripts/generate-coverage.nu"
       - ".doc/resources/*"
-      - "fmt/formatters.nu"
+      - "fmt/resources/*.nu"
 
 defaults:
   run:
@@ -33,7 +32,7 @@ jobs:
 
       - name: Generate Readme
         run: |
-          nu .github/scripts/generate-readme.nu
+          nu .github/scripts/generate-coverage.nu
 
       - name: Commit & push changes
         run: |

.github/workflows/readme.yml

@@ -7,8 +7,7 @@ A Nushell-native kubernetes toolkit
 
 ---
 
-**Nuke** natively brings Kubernetes resource inspection to [Nushell](https://www.nushell.sh/).  
-It exposes kubectl-like commands that query the Kubernetes API-Server and return results the Nushell way.
+**Nuke** natively brings Kubernetes resource inspection to Nushell: it exposes kubectl-like commands that query the Kubernetes API-Server and return results the Nushell way.
 
 Nuke **aims** to return data that is structured, queryable and typed, enabling you to execute commands like
 ```nu
@@ -53,6 +52,7 @@ All flags, resources and resource names support autocompletion.
 
 > **Note:** Nuke is under active development.
 > Not all resources currently support `compact` and `wide` formats — when unavailable, Nuke falls back to `full`.
+> You can see [here](.doc/resource-coverage/coverage.md) the list of supported formatters for the `nuke get` method.
 
 ### Set-Context and Set-Namespace
 The config module provides two methods to switch current context and current namespace using nushell input and autoocmpletion functionalities.
@@ -121,8 +121,6 @@ Planned:
 - OIDC
 - Exec plugins
 
----
-
 ## Contributing
 
 Contributions, bug reports, and feature requests are truly welcome.
@@ -146,78 +144,3 @@ Please open an issue or pull request if you’d like to help improve Nuke.
 - [ ] Implement additional authentication methods:
   - [ ] OIDC
   - [ ] Exec plugins
-
-# Resources Implementation Status
-
-### Coverage
-
-```mermaid
-pie title Resource Coverage
-    "supported" : 44
-    "unsupported" : 13
-    "unwilling to support" : 2
-
-```
-
-### List
-
-| Resource       | Status |
-|-----------------|--------|
-| apiservices     | 🟢     |
-| certificatesigningrequests     | ⚪     |
-| clusterrolebindings     | 🟢     |
-| clusterroles     | 🟢     |
-| componentstatuses     | 🔴    |
-| configmaps     | 🟢     |
-| controllerrevisions     | 🟢     |
-| cronjobs     | 🟢     |
-| csidrivers     | 🟢     |
-| csinodes     | ⚪     |
-| csistoragecapacities     | ⚪     |
-| customresourcedefinitions     | 🟢     |
-| daemonsets     | 🟢     |
-| deployments     | 🟢     |
-| deviceclasses     | 🟢     |
-| endpoints     | 🔴    |
-| endpointslices     | 🟢     |
-| events     | 🟢     |
-| flowschemas     | 🟢     |
-| horizontalpodautoscalers     | 🟢     |
-| ingressclasses     | 🟢     |
-| ingresses     | 🟢     |
-| ipaddresses     | 🟢     |
-| jobs     | 🟢     |
-| leases     | ⚪     |
-| limitranges     | 🟢     |
-| mutatingwebhookconfigurations     | ⚪     |
-| namespaces     | 🟢     |
-| networkpolicies     | 🟢     |
-| nodes     | 🟢     |
-| persistentvolumeclaims     | 🟢     |
-| persistentvolumes     | 🟢     |
-| poddisruptionbudgets     | 🟢     |
-| pods     | 🟢     |
-| podtemplates     | 🟢     |
-| priorityclasses     | 🟢     |
-| prioritylevelconfigurations     | 🟢     |
-| replicasets     | 🟢     |
-| replicationcontrollers     | ⚪     |
-| resourceclaims     | ⚪     |
-| resourceclaimtemplates     | 🟢     |
-| resourcequotas     | 🟢     |
-| resourceslices     | ⚪     |
-| rolebindings     | 🟢     |
-| roles     | 🟢     |
-| runtimeclasses     | 🟢     |
-| secrets     | 🟢     |
-| serviceaccounts     | 🟢     |
-| servicecidrs     | 🟢     |
-| services     | 🟢     |
-| statefulsets     | 🟢     |
-| storageclasses     | 🟢     |
-| validatingadmissionpolicies     | ⚪     |
-| validatingadmissionpolicybindings     | ⚪     |
-| validatingwebhookconfigurations     | ⚪     |
-| volumeattachments     | 🟢     |
-| volumeattributesclasses     | 🟢     |
-