From d20d8fc238dd66c8eedae3a5e35826a7afa19f4d Mon Sep 17 00:00:00 2001 From: Nulo Date: Fri, 25 Nov 2022 22:01:30 -0300 Subject: [PATCH] TypeScript --- .gitignore | 2 + .woodpecker.yml | 9 ++-- package.json | 3 +- pnpm-lock.yaml | 8 +++ index.js => src/index.ts | 48 +++++++++++------- tsconfig.json | 104 +++++++++++++++++++++++++++++++++++++++ 6 files changed, 152 insertions(+), 22 deletions(-) rename index.js => src/index.ts (78%) create mode 100644 tsconfig.json diff --git a/.gitignore b/.gitignore index 57db519..2fc146a 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,5 @@ node_modules/ # Contains publish secrets .npmrc + +src/**.js diff --git a/.woodpecker.yml b/.woodpecker.yml index 51cb002..3b8d521 100644 --- a/.woodpecker.yml +++ b/.woodpecker.yml @@ -8,7 +8,8 @@ pipeline: - apk add --quiet curl nodejs npm git git-lfs tar zstd - curl -fsSL "https://github.com/pnpm/pnpm/releases/latest/download/pnpm-linuxstatic-x64" -o /bin/pnpm; chmod +x /bin/pnpm - pnpm set registry http://npm.proxy.coso - - pnpm install --prod --silent + - pnpm install --silent + - pnpm tsc - git clone https://gitea.nulo.in/Nulo/site-analyzer-demos - cd site-analyzer-demos @@ -16,7 +17,7 @@ pipeline: - tar xf la-periferica.com.ar.tar.zst - tar xf distributed.press.tar.zst - - time node .. nulo.in/ - - time node .. la-periferica.com.ar/ - - time node .. distributed.press/ + - time node ../src nulo.in/ + - time node ../src la-periferica.com.ar/ + - time node ../src distributed.press/ diff --git a/package.json b/package.json index 123f5df..d879293 100644 --- a/package.json +++ b/package.json @@ -16,6 +16,7 @@ }, "devDependencies": { "@types/htmlparser2": "^3.10.3", - "@types/node": "^18.11.9" + "@types/node": "^18.11.9", + "typescript": "^4.9.3" } } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 6dea3cb..921a0a9 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -5,6 +5,7 @@ specifiers: '@types/node': ^18.11.9 domhandler: ^5.0.3 htmlparser2: ^8.0.1 + typescript: ^4.9.3 dependencies: domhandler: 5.0.3 @@ -13,6 +14,7 @@ dependencies: devDependencies: '@types/htmlparser2': 3.10.3 '@types/node': 18.11.9 + typescript: 4.9.3 packages: @@ -84,3 +86,9 @@ packages: domutils: 3.0.1 entities: 4.4.0 dev: false + + /typescript/4.9.3: + resolution: {integrity: sha512-CIfGzTelbKNEnLpLdGFgdyKhG23CKdKgQPOBc+OUNrkJ2vr+KSzsSV5kq5iWhEQbok+quxgGzrAtGWCyU7tHnA==} + engines: {node: '>=4.2.0'} + hasBin: true + dev: true diff --git a/index.js b/src/index.ts similarity index 78% rename from index.js rename to src/index.ts index fb66d60..dfee391 100644 --- a/index.js +++ b/src/index.ts @@ -1,12 +1,25 @@ import { Parser } from "htmlparser2"; -import { DomHandler } from "domhandler"; +import { DomHandler, Element } from "domhandler"; import { readdir, readFile } from "fs/promises"; import { join } from "path"; const { argv } = process; const dirPath = argv[2] || "."; +interface Thing { + type: + | "link-http" + | "link-absolute" + | "link-no-href" + | "media-http" + | "media-absolute" + | "media-no-src"; + description: string; +} +interface Report { + things: Thing[]; +} -function recurseElement(report, rawHtml, el) { +function recurseElement(report: Report, rawHtml: string, el: Element) { if (el.name === "a") { if (el.attribs.href !== undefined) { if (isHttp(el.attribs.href)) { @@ -29,7 +42,7 @@ function recurseElement(report, rawHtml, el) { } if (["audio", "video", "img", "source"].includes(el.name)) { if (el.attribs.src) { - checkUrl(report, rawHtml, "media", el, el.attribs.src); + checkUrl(report, rawHtml, el, el.attribs.src); } else { report.things.push({ type: "media-no-src", @@ -45,32 +58,32 @@ function recurseElement(report, rawHtml, el) { } } -function checkUrl(report, rawHtml, type, el, url) { +function checkUrl(report: Report, rawHtml: string, el: Element, url: string) { if (isHttp(url)) { report.things.push({ - type: type + "-http", + type: "media-http", description: getHtml(rawHtml, el), }); } else if (isAbsolute(url)) { report.things.push({ - type: type + "-absolute", + type: "media-absolute", description: getHtml(rawHtml, el), }); } } -function isHttp(url) { +function isHttp(url: string) { const r = /^(https?:\/\/|\/\/)/; return r.test(url); } -function isAbsolute(url) { +function isAbsolute(url: string) { return url.startsWith("/"); } -function getHtml(rawHtml, el) { - return rawHtml.slice(el.startIndex, el.endIndex); +function getHtml(rawHtml: string, el: Element) { + return rawHtml.slice(el.startIndex!, el.endIndex!); } -function getText(el) { +function getText(el: Element) { let text = ""; for (const child of el.children) { if (child.type === "text") text += child.data.trim(); @@ -79,17 +92,15 @@ function getText(el) { return text; } -function processFile(content) { +function processFile(content: string): Promise { return new Promise((resolve, reject) => { const handler = new DomHandler( (error, dom) => { if (error) { reject(error); } else { - let report = { + let report: Report = { things: [], - warnings: [], - infos: [], }; for (const el of dom) { if (el.type === "tag") { @@ -106,8 +117,11 @@ function processFile(content) { }); } -let reports = {}; -async function recurseDirectory(reports, path) { +interface Reports { + [key: string]: Report; +} +let reports: Reports = {}; +async function recurseDirectory(reports: Reports, path: string) { const dir = await readdir(path, { withFileTypes: true }); for (const file of dir) { const filePath = join(path, file.name); diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..1cdd25d --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,104 @@ +{ + "include": ["src/**/*"], + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2017" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */, + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "es2022" /* Specify what module code is generated. */, + // "rootDir": "./", /* Specify the root folder within your source files. */ + "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */, + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + // "outDir": "./", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */, + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */, + + /* Type Checking */ + "strict": true /* Enable all strict type-checking options. */, + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +}