ignore typescript false positives

Author: Björn Büttner

.npmignore

@@ -0,0 +1,8 @@
+/test
+.eslintrc.yml
+/.nyc_output
+/coverage
+/.mocharc.cjs
+/.nycrc.json
+/fixtures
+/tools

README.md

@@ -4,7 +4,7 @@ This is a small library used to teach the default react routers file based routi
 
 ## Defining a page
 
-A page is by default any ìndex.tsx within the src/pages folder. The folder name will be taken as the page url, with two exceptions:
+A page is by default any `ìndex.tsx` within the `src/pages` folder. The folder name will be taken as the page url, with two exceptions by default:
 
 - home will be the root
 - not-found will be the 404 page
@@ -54,6 +54,6 @@ Default options are overwritten first by the file based settings and then by the
 
 You will need to do three things for the complete package:
 
-- Define a call to generate-routes in you package.json as afterInstall and early in your build process to generate the routes.tsx and the sitemap
-- Optionally define a call to generate-folders in your package.json as a late build step to optimise the index.html files
-- Import the generated src/routes.tsx, so that you can use createBrowserRouter or similar functions to create your router
+- Define a call to generate-routes(`irfbrgr` or `react-file-based-routes-generate-routes`) in you package.json as afterInstall and early in your build process to generate the routes.tsx and the sitemap
+- Optionally define a call to generate-folders(`ìrfbrgf` or `react-file-based-routes-generate-folders`) in your package.json as a late build step to optimise the index.html files
+- Default import the generated `src/routes.tsx`, so that you can use createBrowserRouter or similar functions to create your router. It requires getting a `Loader` element passed to it - any react element will do

package.json

@@ -3,6 +3,12 @@
   "version": "1.0.0",
   "description": "A simple file based routing library, that does not force itself on you.",
   "type": "module",
+  "keywords": [
+    "react",
+    "routing",
+    "file-based-routing",
+    "library"
+  ],
   "bin": {
     "react-file-based-routes-generate-routes": "bin/generate-routes.js",
     "react-file-based-routes-generate-folders": "bin/generate-folders.js",
@@ -25,6 +31,9 @@
     "react": "^18.2.0"
   },
   "scripts": {
-    "tsc": "tsc -p tsconfig.json"
+    "tsc": "tsc -p tsconfig.json",
+    "prepublishOnly": "npm run tsc",
+    "clear": "rm src/*.js",
+    "postpublish": "npm run clear"
   }
 }

src/configuration.ts

@@ -3,36 +3,41 @@ import {
   existsSync,
 } from 'fs';
 
-export interface Configuration {
-  sitemap: {
-    domain: string,
-    build: boolean,
-  },
-  routes: {
-    build: boolean,
-    type: 'tsx'|'jsx',
-    overridePathMappings: {
-      [filesystemPath: string]: string,
-    },
-  },
-  htmlMinify: {
-    collapseBooleanAttributes: boolean,
-    conservativeCollapse: boolean,
-    collapseWhitespace: boolean,
-    removeAttributeQuotes: boolean,
-    removeComments: boolean,
-  },
-  fileBuilder: {
-    buildIndex: boolean,
-    minifyPages: boolean,
-    appendPageChunk: boolean,
-  },
-  fileFinder: {
-    fileName: string,
-    pagesRoot: string,
-    distJSRoot: string,
+interface Sitemap {
+  domain: string,
+  build: boolean,
+}
+interface Routes {
+  build: boolean,
+  type: 'tsx'|'jsx',
+  overridePathMappings: {
+    [filesystemPath: string]: string,
   },
 }
+interface HTMLMinify {
+  collapseBooleanAttributes: boolean,
+  conservativeCollapse: boolean,
+  collapseWhitespace: boolean,
+  removeAttributeQuotes: boolean,
+  removeComments: boolean,
+}
+interface FileBuilder {
+  buildIndex: boolean,
+  minifyPages: boolean,
+  appendPageChunk: boolean,
+}
+interface FileFinder {
+  fileName: string,
+  pagesRoot: string,
+  distJSRoot: string,
+}
+export interface Configuration {
+  sitemap: Sitemap,
+  routes: Routes,
+  htmlMinify: HTMLMinify,
+  fileBuilder: FileBuilder,
+  fileFinder: FileFinder,
+}
 
 export default (cwd: string, cliArguments: string[]): Configuration => {
   const config: Configuration = {
@@ -68,11 +73,11 @@ export default (cwd: string, cliArguments: string[]): Configuration => {
   };
   const configFile = cwd + '/.idrinth-react-file-based-routes.json';
   if (existsSync(configFile)) {
-    const userconfig: Partial<Configuration> = JSON.parse(readFileSync(configFile, 'utf-8'));
+    const userconfig: Configuration = JSON.parse(readFileSync(configFile, 'utf-8'));
     if (typeof userconfig === 'object') {
-      for (const prop of Object.keys(config)) {
+      for (const prop of Object.keys(config) as [keyof Configuration]) {
         if (typeof userconfig[prop] === 'object' && typeof config[prop] === 'object') {
-          for (const setting of Object.keys(config[prop])) {
+          for (const setting of Object.keys(config[prop]) as [keyof Configuration[typeof prop]]) {
             if (typeof config[prop][setting] === typeof userconfig[prop][setting]) {
               config[prop][setting] = userconfig[prop][setting];
             }
@@ -83,12 +88,24 @@ export default (cwd: string, cliArguments: string[]): Configuration => {
   }
   for (const param of cliArguments) {
     if (param.startsWith('--')) {
-      const [setting, value,] = param.substring(2).split('=');
-      const [group, detail,] = setting.split('.');
+      const [setting, value,] = param.substring(2).split('=') as [string, undefined|string];
+      const [group, detail,] = setting.split('.') as [keyof Configuration, keyof Sitemap|keyof Routes|keyof FileFinder|keyof FileBuilder|keyof HTMLMinify];
       if (group && typeof config[group] === 'object' && detail) {
+        // @ts-ignore TS7053
         if (typeof config[group][detail] === 'boolean') {
-          config[group][detail] = !config[group][detail];
-        } else if(typeof config[group][detail] === 'string' && value) {
+          if (value === 'true') {
+            // @ts-ignore TS7053
+            config[group][detail] = true;
+          } else if (value === 'false') {
+            // @ts-ignore TS7053
+            config[group][detail] = false;
+          } else {
+            // @ts-ignore TS7053
+            config[group][detail] = !config[group][detail];
+          }
+        // @ts-ignore TS7053
+        } else if (typeof config[group][detail] === 'string' && value) {
+          // @ts-ignore TS7053
           config[group][detail] = value;
         }
       }
@@ -97,5 +114,8 @@ export default (cwd: string, cliArguments: string[]): Configuration => {
   if (config.sitemap.build && !config.sitemap.domain) {
     throw new Error('sitemap.domain must be set if a sitemap should be build.');
   }
+  if (config.routes.type !== 'tsx' && config.routes.type !== 'jsx') {
+    throw new Error('config.routes.type must be set to either tsx or jsx.');
+  }
   return config;
 }

src/generate-routes.ts

@@ -1,10 +1,10 @@
 import {readdirSync, statSync, writeFileSync,} from 'fs';
 import paddedDate from './padded-date.js';
 import {Configuration} from "./configuration.js";
-import TsxWriter from "./tsx-writer";
-import JsxWriter from "./jsx-writer";
-import SitemapWriter from "./sitemap-writer";
-import Writer from "./writer";
+import TsxWriter from './tsx-writer.js';
+import JsxWriter from './jsx-writer.js';
+import SitemapWriter from './sitemap-writer.js';
+import Writer from './writer.js';
 
 export default (cwd: string, configuration: Configuration) => {
   const writers: Writer[] = [];
@@ -15,7 +15,7 @@ export default (cwd: string, configuration: Configuration) => {
     writers.push(new JsxWriter())
   }
   if (configuration.sitemap.build) {
-    writers.push(new SitemapWriter());
+    writers.push(new SitemapWriter(configuration.sitemap.domain));
   }
   for (const file of readdirSync(cwd + '/' + configuration.fileFinder.pagesRoot, {encoding: 'utf8', recursive: true})) {
     if (file.endsWith('/' + configuration.fileFinder.fileName) || file.endsWith('\\' + configuration.fileFinder.fileName)) {
@@ -24,7 +24,7 @@ export default (cwd: string, configuration: Configuration) => {
       const path = file.replace(/\\/ug, '/').substring(0, file.length - configuration.fileFinder.fileName.length - 1);
       const url = typeof configuration.routes.overridePathMappings[path] === 'string' ? configuration.routes.overridePathMappings[path] : `/${path}/`;
       for (const writer of writers) {
-        writer.add(path, url, configuration.sitemap.domain, changed);
+        writer.add(path, url, changed);
       }
     }
   }

src/jsx-writer.ts

@@ -5,7 +5,8 @@ export default class JsxWriter implements Writer {
     return 'src/routes.jsx';
   }
   private items: string[] = [];
-  add(path: string, url: string, domain: string, changed: string): void
+  // @ts-ignore TS6133
+  add(path: string, url: string, changed: string): void
   {
     this.items.push('  ' + `(() => {
     const LazyElement = lazy(() => import(

src/sitemap-writer.ts

@@ -5,12 +5,15 @@ export default class SitemapWriter implements Writer {
     return 'public/sitemap.xml';
   }
   private items: string[] = [];
-  add(path: string, url: string, domain: string, changed: string): void
+  constructor(private readonly domain: string) {
+  }
+  // @ts-ignore TS6133
+  add(path: string, url: string, changed: string): void
   {
     if (url === '*') {
       return;
     }
-    this.items.push(`<url><loc>https://${domain}/${url}/</loc><lastmod>${changed}</lastmod></url>`);
+    this.items.push(`<url><loc>https://${this.domain}/${url}/</loc><lastmod>${changed}</lastmod></url>`);
   }
   toString(): string {
     return '<?xml version="1.0" encoding="UTF-8"?>' +

src/tsx-writer.ts

@@ -5,7 +5,8 @@ export default class TsxWriter implements Writer {
       return 'src/routes.tsx';
   }
   private items: string[] = [];
-  add(path: string, url: string, domain: string, changed: string): void
+  // @ts-ignore TS6133
+  add(path: string, url: string, changed: string): void
   {
     this.items.push('  ' + `(() => {
     const LazyElement = lazy(() => import(

src/writer.ts

@@ -1,5 +1,5 @@
 export default interface Writer {
-  add(path: string, url: string, domain: string, changed: string): void;
+  add(path: string, url: string, changed: string): void;
   toString(): string;
   fileName(): string;
 }

tsconfig.json

@@ -2,19 +2,14 @@
   "compilerOptions": {
     "noImplicitAny": true,
     "target": "ES2020",
-    "useDefineForClassFields": true,
-    "module": "ESNext",
-    "skipLibCheck": true,
-    "moduleResolution": "bundler",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
+    "module": "NodeNext",
     "jsx": "react",
     "strict": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "noFallthroughCasesInSwitch": true,
-    "incremental": true,
-    "allowSyntheticDefaultImports": true
+    "allowSyntheticDefaultImports": true,
+    "moduleResolution": "NodeNext"
   },
   "include": [
     "src/**/*.ts"