Merge pull request #192 from what1s1ove/task/wd-173-jsdoc

wd-173: add jsdoc support

.eslintrc.yml

@@ -8,6 +8,7 @@ extends:
   - plugin:sonarjs/recommended
   - plugin:unicorn/recommended
   - plugin:perfectionist/recommended-natural
+  - plugin:jsdoc/recommended-typescript-flavor-error
 
 plugins:
   - simple-import-sort
@@ -17,6 +18,8 @@ parserOptions:
   sourceType: module
 
 settings:
+  jsdoc:
+    mode: typescript
   import/resolver:
     alias:
       extensions:
@@ -111,6 +114,25 @@ rules:
   import/extensions:
     - error
     - ignorePackages
+  jsdoc/require-jsdoc:
+    - error
+    - checkConstructors: false
+      checkGetters: true
+      checkSetters: true
+      contexts:
+        - ArrowFunctionExpression
+        - ClassProperty
+        - FunctionDeclaration
+        - FunctionExpression
+        - MethodDefinition
+  jsdoc/valid-types:
+    - off
+  jsdoc/require-returns-description:
+    - off
+  jsdoc/require-param-description:
+    - off
+  jsdoc/require-property-description:
+    - off
 
 overrides:
   - files:

.lintstagedrc.yml

@@ -1,4 +1,4 @@
-'*.{json,md}': prettier --write
+'*.{json,yml,css,js,cjs,d.ts}': prettier --write
 '*': make lint_editorconfig lint_fs
 '*.css': make lint_css
-'*.js': make lint_js
+'*.js': make lint_js lint_type

.prettierrc.yml

@@ -1,3 +1,5 @@
+plugins:
+  - 'prettier-plugin-jsdoc'
 printWidth: 80
 tabWidth: 2
 useTabs: false

Makefile

@@ -14,7 +14,7 @@ build: clean
 # Prettify
 
 prettify:
-	npx prettier --write "**/*.{json,yml,css,js,cjs}"
+	npx prettier --write "**/*.{json,yml,css,js,cjs,d.ts}"
 
 # Lint
 
@@ -23,11 +23,13 @@ lint_fs:
 lint_editorconfig:
 	npx editorconfig-checker
 lint_prettify:
-	npx prettier --check "**/*.{json,yml,css,js,cjs}"
+	npx prettier --check "**/*.{json,yml,css,js,cjs,d.ts}"
 lint_html:
 	npx node-w3c-validator -i build/*.html -f lint -evH
 lint_css:
 	npx stylelint "source/styles/**/*.css"
 lint_js:
 	npx eslint --ext .js "**/*.{js,cjs}"
-lint: lint_fs lint_editorconfig lint_prettify lint_html lint_css lint_js
+lint_type:
+	npx tsc --noEmit
+lint: lint_fs lint_editorconfig lint_prettify lint_html lint_css lint_js lint_type

eleventy.config.cjs

@@ -1,3 +1,5 @@
+let fs = require(`node:fs/promises`)
+let process = require(`node:process`)
 let esbuild = require(`esbuild`)
 let lightningcss = require(`lightningcss`)
 let htmlMin = require(`html-minifier-terser`)
@@ -8,7 +10,6 @@ let packageJson = require(`./package.json`)
 let Image = require(`@11ty/eleventy-img`)
 let svgo = require(`svgo`)
 let path = require(`node:path`)
-let fs = require(`node:fs/promises`)
 
 let isDevelopment = process.env.NODE_ENV === `development`
 
@@ -28,7 +29,10 @@ let Path = {
   },
 }
 
-/** @param {import("@11ty/eleventy").UserConfig} config */
+/**
+ * @param {import('@11ty/eleventy').UserConfig} config
+ * @returns {ReturnType<typeof import('@11ty/eleventy/src/defaultConfig')>}
+ */
 let init = (config) => {
   // ignores
   if (!isDevelopment) {
@@ -44,6 +48,7 @@ let init = (config) => {
   config.addTemplateFormats(`json`)
 
   config.addExtension(`json`, {
+    /** @type {import('@11ty/eleventy/src/Engines/TemplateEngine')['compile']} */
     compile: async (_content, url) => {
       if (url !== Path.DB) {
         return
@@ -84,6 +89,7 @@ let init = (config) => {
   config.addTemplateFormats(`css`)
 
   config.addExtension(`css`, {
+    /** @type {import('@11ty/eleventy/src/Engines/TemplateEngine')['compile']} */
     compile: async (_content, url) => {
       if (url !== Path.CSS) {
         return
@@ -114,6 +120,7 @@ let init = (config) => {
   config.addTemplateFormats(`js`)
 
   config.addExtension(`js`, {
+    /** @type {import('@11ty/eleventy/src/Engines/TemplateEngine')['compile']} */
     compile: async (_content, url) => {
       if (url !== Path.JS.MAIN) {
         return
@@ -162,6 +169,7 @@ let init = (config) => {
   config.addTemplateFormats(`png`)
 
   config.addExtension(`png`, {
+    /** @type {import('@11ty/eleventy/src/Engines/TemplateEngine')['compile']} */
     compile: async (_content, url) => {
       return async () => {
         let {
@@ -173,6 +181,7 @@ let init = (config) => {
 
         if (url.includes(`.photo.`)) {
           await Image(url, {
+            /** @type {import('@11ty/eleventy-img').BaseImageOptions['filenameFormat']} */
             filenameFormat: (_id, source, _width, format) => {
               let extension = path.extname(source)
               let name = path.basename(source, extension)
@@ -194,6 +203,7 @@ let init = (config) => {
   config.addTemplateFormats(`svg`)
 
   config.addExtension(`svg`, {
+    /** @type {import('@11ty/eleventy/src/Engines/TemplateEngine')['compile']} */
     compile: (content, url) => {
       return () => {
         if (url === `./source/images/icons/icon.svg`) {