update docs

tsirysndr · tsirysndr · commit 93b3842ac938 · 2024-03-04T08:24:33.000Z
diff --git a/ansible-lint/deno.json b/ansible-lint/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@daggerverse/ansible-lint",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "exports": "./mod.ts",
   "importMap": "import_map.json",
   "tasks": {
diff --git a/ansible-lint/src/dagger/index.ts b/ansible-lint/src/dagger/index.ts
@@ -1,4 +1,3 @@
-import pipeline from "./pipeline.ts";
 import { lint, dev, jobDescriptions } from "./jobs.ts";
 
-export { pipeline, lint, dev, jobDescriptions };
+export { lint, dev, jobDescriptions };
diff --git a/ansible-lint/src/dagger/jobs.ts b/ansible-lint/src/dagger/jobs.ts
@@ -14,6 +14,8 @@ export enum Job {
 export const exclude = [];
 
 /**
+ * Lint ansible YAML files
+ *
  * @function
  * @description Lint ansible YAML files.
  * @param {string | Directory | undefined} src
diff --git a/ansible/deno.json b/ansible/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@daggerverse/ansible",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "exports": "./mod.ts",
   "importMap": "import_map.json",
   "tasks": {
diff --git a/ansible/src/dagger/index.ts b/ansible/src/dagger/index.ts
@@ -1,4 +1,3 @@
-import pipeline from "./pipeline.ts";
 import { playbook, dev, jobDescriptions } from "./jobs.ts";
 
-export { pipeline, playbook, dev, jobDescriptions };
+export { playbook, dev, jobDescriptions };
diff --git a/ansible/src/dagger/jobs.ts b/ansible/src/dagger/jobs.ts
@@ -13,8 +13,10 @@ export enum Job {
 export const exclude = [];
 
 /**
+ * Run a playbook
+ *
  * @function
- * @description Runs a playbook.
+ * @description Run a playbook.
  * @param {string | Directory | undefined} src
  * @param {string} playbook
  * @param {string} tag
diff --git a/awesome-ci/deno.json b/awesome-ci/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@daggerverse/awesome-ci",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "exports": "./mod.ts",
   "importMap": "import_map.json",
   "tasks": {
diff --git a/awesome-ci/src/dagger/index.ts b/awesome-ci/src/dagger/index.ts
@@ -24,10 +24,8 @@ import { syntaxPython } from "./jobs/syntax-python.ts";
 import { syntaxRuby } from "./jobs/syntax-ruby.ts";
 import { syntaxScss } from "./jobs/syntax-scss.ts";
 import { syntaxSh } from "./jobs/syntax-sh.ts";
-import pipeline from "./pipeline.ts";
 
 export {
-  pipeline,
   dev,
   gitConflicts,
   gitIgnored,
diff --git a/awesome-ci/src/dagger/jobs/file-cr.ts b/awesome-ci/src/dagger/jobs/file-cr.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan files and check if they contain CR (Carriage Return only)
+ *
  * @function
  * @description Scan files and check if they contain CR (Carriage Return only).
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/file-crlf.ts b/awesome-ci/src/dagger/jobs/file-crlf.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan files and check if they contain CRLF (Windows Line Feeds)
+ *
  * @function
  * @description Scan files and check if they contain CRLF (Windows Line Feeds).
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/file-empty.ts b/awesome-ci/src/dagger/jobs/file-empty.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan files and check if they are empty (0 bytes)
+ *
  * @function
  * @description Scan files and check if they are empty (0 bytes).
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/file-nullbyte-char.ts b/awesome-ci/src/dagger/jobs/file-nullbyte-char.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan files and check if they contain a null-byte character (\x00)
+ *
  * @function
  * @description Scan files and check if they contain a null-byte character (\x00).
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/file-trailing-newline.ts b/awesome-ci/src/dagger/jobs/file-trailing-newline.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan files and check if they contain a trailing newline
+ *
  * @function
  * @description Scan files and check if they contain a trailing newline.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/file-trailing-single-newline.ts b/awesome-ci/src/dagger/jobs/file-trailing-single-newline.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan files and check if they contain exactly one trailing newline
+ *
  * @function
  * @description Scan files and check if they contain exactly one trailing newline.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/file-trailing-space.ts b/awesome-ci/src/dagger/jobs/file-trailing-space.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan files and check if they contain trailing whitespaces
+ *
  * @function
  * @description Scan files and check if they contain trailing whitespaces.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/file-utf8-bom.ts b/awesome-ci/src/dagger/jobs/file-utf8-bom.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan files and check if they contain BOM (Byte Order Mark): <U+FEFF>
+ *
  * @function
  * @description Scan files and check if they contain BOM (Byte Order Mark): <U+FEFF>.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/file-utf8.ts b/awesome-ci/src/dagger/jobs/file-utf8.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan files and check if they have a non UTF-8 encoding
+ *
  * @function
  * @description Scan files and check if they have a non UTF-8 encoding.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/git-conflicts.ts b/awesome-ci/src/dagger/jobs/git-conflicts.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan files and check if they contain git conflicts
+ *
  * @function
  * @description Scan files and check if they contain git conflicts.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/git-ignored.ts b/awesome-ci/src/dagger/jobs/git-ignored.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan git directory and see if ignored files are still in git cache
+ *
  * @function
  * @description Scan git directory and see if ignored files are still in git cache.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/inline-css.ts b/awesome-ci/src/dagger/jobs/inline-css.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan files and check if they contain inline css code
+ *
  * @function
  * @description Scan files and check if they contain inline css code.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/inline-js.ts b/awesome-ci/src/dagger/jobs/inline-js.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan files and check if they contain inline javascript code
+ *
  * @function
  * @description Scan files and check if they contain inline javascript code.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/syntax-bash.ts b/awesome-ci/src/dagger/jobs/syntax-bash.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan shell files for bash syntax errors
+ *
  * @function
  * @description Scan shell files for bash syntax errors.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/syntax-css.ts b/awesome-ci/src/dagger/jobs/syntax-css.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan CSS files for CSS syntax errors
+ *
  * @function
  * @description Scan CSS files for CSS syntax errors.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/syntax-js.ts b/awesome-ci/src/dagger/jobs/syntax-js.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan JS files for JS syntax errors
+ *
  * @function
  * @description Scan JS files for JS syntax errors.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/syntax-json.ts b/awesome-ci/src/dagger/jobs/syntax-json.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan files for JSON syntax errors
+ *
  * @function
  * @description Scan files for JSON syntax errors.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/syntax-markdown.ts b/awesome-ci/src/dagger/jobs/syntax-markdown.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan files for Markdown syntax errors
+ *
  * @function
  * @description Scan files for Markdown syntax errors.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/syntax-perl.ts b/awesome-ci/src/dagger/jobs/syntax-perl.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan Perl files for Perl syntax errors
+ *
  * @function
  * @description Scan Perl files for Perl syntax errors.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/syntax-php.ts b/awesome-ci/src/dagger/jobs/syntax-php.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan PHP files for PHP syntax errors
+ *
  * @function
  * @description Scan PHP files for PHP syntax errors.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/syntax-python.ts b/awesome-ci/src/dagger/jobs/syntax-python.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan Python files for Python syntax errors
+ *
  * @function
  * @description Scan Python files for Python syntax errors.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/syntax-ruby.ts b/awesome-ci/src/dagger/jobs/syntax-ruby.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan Ruby files for Ruby syntax errors
+ *
  * @function
  * @description Scan Ruby files for Ruby syntax errors.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/syntax-scss.ts b/awesome-ci/src/dagger/jobs/syntax-scss.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan SCSS files for SCSS syntax errors
+ *
  * @function
  * @description Scan SCSS files for SCSS syntax errors.
  * @param {string | Directory | undefined} src
diff --git a/awesome-ci/src/dagger/jobs/syntax-sh.ts b/awesome-ci/src/dagger/jobs/syntax-sh.ts
@@ -3,6 +3,8 @@ import { getDirectory } from "../lib.ts";
 import { Job } from "./mod.ts";
 
 /**
+ * Scan sh files for /bin/sh syntax errors
+ *
  * @function
  * @description Scan sh files for /bin/sh syntax errors.
  * @param {string | Directory | undefined} src
diff --git a/checkmake/deno.json b/checkmake/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@daggerverse/checkmake",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "exports": "./mod.ts",
   "importMap": "import_map.json",
   "tasks": {
diff --git a/checkmake/src/dagger/index.ts b/checkmake/src/dagger/index.ts
@@ -1,4 +1,3 @@
-import pipeline from "./pipeline.ts";
 import { lint, jobDescriptions } from "./jobs.ts";
 
-export { pipeline, lint, jobDescriptions };
+export { lint, jobDescriptions };
diff --git a/checkmake/src/dagger/jobs.ts b/checkmake/src/dagger/jobs.ts
@@ -13,6 +13,8 @@ export enum Job {
 export const exclude = [];
 
 /**
+ * Lint Makefiles
+ *
  * @function
  * @description Lint Makefiles.
  * @param {string | Directory | undefined} src
diff --git a/flakestry/deno.json b/flakestry/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@daggerverse/flakestry",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "exports": "./mod.ts",
   "importMap": "import_map.json",
   "tasks": {
diff --git a/flakestry/src/dagger/index.ts b/flakestry/src/dagger/index.ts
@@ -1,4 +1,3 @@
-import pipeline from "./pipeline.ts";
 import { publish, jobDescriptions } from "./jobs.ts";
 
-export { pipeline, publish, jobDescriptions };
+export { publish, jobDescriptions };
diff --git a/flakestry/src/dagger/jobs.ts b/flakestry/src/dagger/jobs.ts
@@ -13,6 +13,8 @@ export enum Job {
 export const exclude = [];
 
 /**
+ * Publish a flake to flakestry.dev
+ *
  * @function
  * @description Publish a flake to flakestry.dev
  * @param {string | Directory} src
diff --git a/jsonlint/deno.json b/jsonlint/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@daggerverse/jsonlint",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "exports": "./mod.ts",
   "importMap": "import_map.json",
   "tasks": {
diff --git a/jsonlint/src/dagger/index.ts b/jsonlint/src/dagger/index.ts
@@ -1,4 +1,3 @@
-import pipeline from "./pipeline.ts";
 import { lint, jobDescriptions } from "./jobs.ts";
 
-export { pipeline, lint, jobDescriptions };
+export { lint, jobDescriptions };
diff --git a/jsonlint/src/dagger/jobs.ts b/jsonlint/src/dagger/jobs.ts
@@ -13,6 +13,8 @@ export enum Job {
 export const exclude = [];
 
 /**
+ * Lint JSON files
+ *
  * @function
  * @description Lint JSON files.
  * @param {string | Directory | undefined} src
diff --git a/kubeconform/deno.json b/kubeconform/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@daggerverse/kubeconform",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "exports": "./mod.ts",
   "importMap": "import_map.json",
   "tasks": {
diff --git a/kubeconform/src/dagger/index.ts b/kubeconform/src/dagger/index.ts
@@ -1,4 +1,3 @@
-import pipeline from "./pipeline.ts";
 import { lint, dev, jobDescriptions } from "./jobs.ts";
 
-export { pipeline, lint, dev, jobDescriptions };
+export { lint, dev, jobDescriptions };
diff --git a/r2-sync/deno.json b/r2-sync/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@daggerverse/r2-sync",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "exports": "./mod.ts",
   "importMap": "import_map.json",
   "tasks": {
diff --git a/r2-sync/src/dagger/index.ts b/r2-sync/src/dagger/index.ts
@@ -1,4 +1,3 @@
-import pipeline from "./pipeline.ts";
 import { dev, upload, jobDescriptions } from "./jobs.ts";
 
-export { pipeline, dev, upload, jobDescriptions };
+export { dev, upload, jobDescriptions };
diff --git a/r2-sync/src/dagger/jobs.ts b/r2-sync/src/dagger/jobs.ts
@@ -14,8 +14,10 @@ export enum Job {
 export const exclude = [];
 
 /**
+ * Upload files to Cloudlare R2 bucket
+ *
  * @function
- * @description Uploads files to Cloudlare R2 bucket.
+ * @description Upload files to Cloudlare R2 bucket.
  * @param {string | Directory | undefined} src
  * @param {Secret | string} accessKey
  * @param {Secret | string} secretKey
diff --git a/scorecard/deno.json b/scorecard/deno.json
diff --git a/scorecard/src/dagger/index.ts b/scorecard/src/dagger/index.ts
diff --git a/scorecard/src/dagger/jobs.ts b/scorecard/src/dagger/jobs.ts
diff --git a/shellcheck/deno.json b/shellcheck/deno.json
diff --git a/shellcheck/src/dagger/index.ts b/shellcheck/src/dagger/index.ts
diff --git a/shellcheck/src/dagger/jobs.ts b/shellcheck/src/dagger/jobs.ts
diff --git a/terraform-docs/deno.json b/terraform-docs/deno.json
diff --git a/terraform-docs/src/dagger/index.ts b/terraform-docs/src/dagger/index.ts
diff --git a/terraform-docs/src/dagger/jobs.ts b/terraform-docs/src/dagger/jobs.ts
diff --git a/yamllint/deno.json b/yamllint/deno.json
diff --git a/yamllint/src/dagger/index.ts b/yamllint/src/dagger/index.ts
diff --git a/yamllint/src/dagger/jobs.ts b/yamllint/src/dagger/jobs.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@daggerverse/ansible-lint",`
`3`		`- "version": "0.1.0",`
	`3`	`+ "version": "0.1.1",`
`4`	`4`	`"exports": "./mod.ts",`
`5`	`5`	`"importMap": "import_map.json",`
`6`	`6`	`"tasks": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@daggerverse/ansible",`
`3`		`- "version": "0.1.0",`
	`3`	`+ "version": "0.1.1",`
`4`	`4`	`"exports": "./mod.ts",`
`5`	`5`	`"importMap": "import_map.json",`
`6`	`6`	`"tasks": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@daggerverse/awesome-ci",`
`3`		`- "version": "0.1.0",`
	`3`	`+ "version": "0.1.1",`
`4`	`4`	`"exports": "./mod.ts",`
`5`	`5`	`"importMap": "import_map.json",`
`6`	`6`	`"tasks": {`