vivth 1.0.3 → 1.0.4

package/README.md

@@ -1676,10 +1676,12 @@ npm i vivth
 - this autodocumenter uses [chokidar](https://npmjs.com/package/chokidar) under the hood;  
 - this class also is used to generate this `README.md`;  
 - behaviours:  
->1) export all named exported 'const'|'function'|'async function'|'class', alphanumeric name, started with Capital letter, same name with fileName on `options.pahts.file`;  
->2) declare typedef of existing typedef with alphanumeric name, started with Capital letter, same name with fileName, and have no valid export like on point <sup>1</sup> on `options.pahts.file`;  
->3) create `README.md` based on, `options.paths.dir` and `README.src.md`;  
->4) extract `"at"description` jsdoc:  
+>1) add `"at"noautodoc` on self closing jsdoc comment to opt out from generating documentation on said file;  
+>>- auto export must follows the following rules, and there's no way to override;  
+>2) export all named exported 'const'|'function'|'async function'|'class', alphanumeric name, started with Capital letter, same name with fileName on `options.pahts.file`;  
+>3) declare typedef of existing typedef with alphanumeric name, started with Capital letter, same name with fileName, and have no valid export like on point <sup>1</sup> on `options.pahts.file`;  
+>4) create `README.md` based on, `options.paths.dir` and `README.src.md`;  
+>5) extract `"at"description` jsdoc:  
 >>- on static/prop that have depths, all of children should have `"at"static`/`"at"instance` `nameOfImmediateParent`, same block but before `"at"description` comment line;  
 >>- `"at"description` are treated as plain `markdown`;  
 >>- first `"at"${string}` after `"at"description` until `"at"example` will be treated as `javascript` comment block on the `markdown`;  

package/bun.lock

@@ -10,7 +10,7 @@
       "devDependencies": {
         "@types/bun": "latest",
         "concurrently": "^9.2.1",
-        "typescript": "^5.8.3",
+        "typescript": "^5.9.2",
       },
     },
   },

package/index.mjs

@@ -1,7 +1,7 @@
 // @ts-check
 
 /**
- * automatically generated by `vivth.MJSautoDOC`
+ * automatically generated by `vivth.JSautoDOC`
  * @copyright
  * this library is made and distributed under MIT license;
  */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "vivth",
-	"version": "1.0.3",
+	"version": "1.0.4",
 	"description": "extremely simple signal as library primitives",
 	"main": "index.mjs",
 	"types": "./types/index.d.mts",

package/src/doc/JSautoDOC.mjs

@@ -37,10 +37,12 @@ const acceptableExt = new Set(['.mjs', '.mts', '.ts']);
  * - this autodocumenter uses [chokidar](https://npmjs.com/package/chokidar) under the hood;
  * - this class also is used to generate this `README.md`;
  * - behaviours:
- * >1) export all named exported 'const'|'function'|'async function'|'class', alphanumeric name, started with Capital letter, same name with fileName on `options.pahts.file`;
- * >2) declare typedef of existing typedef with alphanumeric name, started with Capital letter, same name with fileName, and have no valid export like on point <sup>1</sup> on `options.pahts.file`;
- * >3) create `README.md` based on, `options.paths.dir` and `README.src.md`;
- * >4) extract `"at"description` jsdoc:
+ * >1) add `"at"noautodoc` on self closing jsdoc comment to opt out from generating documentation on said file;
+ * >>- auto export must follows the following rules, and there's no way to override;
+ * >2) export all named exported 'const'|'function'|'async function'|'class', alphanumeric name, started with Capital letter, same name with fileName on `options.pahts.file`;
+ * >3) declare typedef of existing typedef with alphanumeric name, started with Capital letter, same name with fileName, and have no valid export like on point <sup>1</sup> on `options.pahts.file`;
+ * >4) create `README.md` based on, `options.paths.dir` and `README.src.md`;
+ * >5) extract `"at"description` jsdoc:
  * >>- on static/prop that have depths, all of children should have `"at"static`/`"at"instance` `nameOfImmediateParent`, same block but before `"at"description` comment line;
  * >>- `"at"description` are treated as plain `markdown`;
  * >>- first `"at"${string}` after `"at"description` until `"at"example` will be treated as `javascript` comment block on the `markdown`;
@@ -226,7 +228,7 @@ export class JSautoDOC {
 	 * @returns {string}
 	 */
 	#generateJSDOCFromstring = (string) => {
-		return `\n/**\n * automatically generated by \`vivth.MJSautoDOC\`\n * @copyright\n${string.replace(
+		return `\n/**\n * automatically generated by \`vivth.JSautoDOC\`\n * @copyright\n${string.replace(
 			/^/gm,
 			' * '
 		)}\n */\n`;
@@ -250,6 +252,7 @@ export class JSautoDOC {
 		for await (const path_ of filepaths) {
 			const {
 				documented,
+				content,
 				hasValidExportObject,
 				path: { relative: relativePath },
 				baseName: { noExt },
@@ -261,6 +264,9 @@ export class JSautoDOC {
 					}';`
 				);
 			}
+			if (/\/\*\*[\s\*]*?@noautodoc[\s\*]*?\*\//.test(await content.string())) {
+				continue;
+			}
 			const currentDescription = [];
 			const { readme, typedef } = documented;
 			const [typedefString, error] = await TryAsync(async () => {

package/types/src/doc/JSautoDOC.d.mts

@@ -4,10 +4,12 @@
  * - this autodocumenter uses [chokidar](https://npmjs.com/package/chokidar) under the hood;
  * - this class also is used to generate this `README.md`;
  * - behaviours:
- * >1) export all named exported 'const'|'function'|'async function'|'class', alphanumeric name, started with Capital letter, same name with fileName on `options.pahts.file`;
- * >2) declare typedef of existing typedef with alphanumeric name, started with Capital letter, same name with fileName, and have no valid export like on point <sup>1</sup> on `options.pahts.file`;
- * >3) create `README.md` based on, `options.paths.dir` and `README.src.md`;
- * >4) extract `"at"description` jsdoc:
+ * >1) add `"at"noautodoc` on self closing jsdoc comment to opt out from generating documentation on said file;
+ * >>- auto export must follows the following rules, and there's no way to override;
+ * >2) export all named exported 'const'|'function'|'async function'|'class', alphanumeric name, started with Capital letter, same name with fileName on `options.pahts.file`;
+ * >3) declare typedef of existing typedef with alphanumeric name, started with Capital letter, same name with fileName, and have no valid export like on point <sup>1</sup> on `options.pahts.file`;
+ * >4) create `README.md` based on, `options.paths.dir` and `README.src.md`;
+ * >5) extract `"at"description` jsdoc:
  * >>- on static/prop that have depths, all of children should have `"at"static`/`"at"instance` `nameOfImmediateParent`, same block but before `"at"description` comment line;
  * >>- `"at"description` are treated as plain `markdown`;
  * >>- first `"at"${string}` after `"at"description` until `"at"example` will be treated as `javascript` comment block on the `markdown`;