chore: migrate to ts

README.md

@@ -22,7 +22,7 @@
 
 ## Requirements
 
-- [Node.js](https://nodejs.org/en/) v18 or higher
+- [Node.js](https://nodejs.org/en/) v20 or higher
 
 ## Getting Started
 

index.d.ts

@@ -1,2 +1,2 @@
-export * from "./src/node";
-export * from "./src/web";
+export * from "./src/node.js";
+export * from "./src/web.js";

package.json

@@ -3,7 +3,7 @@
   "version": "2.4.0",
   "description": "NodeSecure security flags",
   "scripts": {
-    "test": "node --test test/",
+    "test": "glob -c \"tsx --test\" \"./test/**/*.spec.ts\"",
     "coverage": "c8 -r html npm test",
     "lint": "eslint index.js",
     "generateFlags": "node scripts/generateFlags.js"
@@ -46,12 +46,17 @@
   "homepage": "https://github.com/NodeSecure/flags#readme",
   "devDependencies": {
     "@nodesecure/eslint-config": "^1.8.0",
+    "@openally/config.typescript": "^1.0.3",
+    "@types/node": "^22.2.0",
+    "@types/turndown": "^5.0.5",
     "c8": "^10.1.2",
-    "eslint": "^9.9.0",
-    "turndown": "^7.1.2"
+    "glob": "^11.0.0",
+    "tsx": "^4.17.0",
+    "turndown": "^7.1.2",
+    "typescript": "^5.5.4"
   },
   "type": "module",
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   }
 }

src/manifest.js → src/manifest.ts

@@ -1,7 +1,16 @@
 /* eslint-disable max-len */
 
 /** @type {flags.Manifest} **/
-export const FLAGS = {
+
+export interface Flag {
+  [key: string]: {
+    emoji: string;
+    title: string;
+    tooltipDescription: string
+  }
+} 
+
+export const FLAGS : Flag = {
   externalCapacity: {
     emoji: "🌍",
     title: "hasExternalCapacity",

src/node.js → src/node.ts

@@ -14,7 +14,7 @@ const kFlagsPath = path.join(__dirname, "flags");
  * @description lazy read a flag file by getting a Node.js ReadableStream
  * @param {!string} name flag (HTML File) name
  */
-export function lazyFetchFlagFile(name) {
+export function lazyFetchFlagFile(name: string): fs.ReadStream {
   if (typeof name !== "string") {
     throw new TypeError("You should provide a flag name");
   }
@@ -29,7 +29,7 @@ export function lazyFetchFlagFile(name) {
   return fs.createReadStream(path.join(kFlagsPath, fileName));
 }
 
-export async function eagerFetchFlagFile(name) {
+export async function eagerFetchFlagFile(name: string): Promise<string> {
   const rStream = lazyFetchFlagFile(name);
   let htmlStr = "";
 

src/web.js → src/web.ts

@@ -1,33 +1,34 @@
 // Import Internal Dependencies
 import { FLAGS } from "./manifest.js";
+import type { Flag } from "./manifest.js";
 
 const kNotFoundFlags = "🔴";
-const kManifestEmoji = Object.fromEntries(getManifestEmoji());
+const kManifestEmoji : Record<string, string> = Object.fromEntries(getManifestEmoji());
 
 /**
  * @description Export src/manifest.json
  */
-export function getManifest() {
+export function getManifest(): Flag {
   return FLAGS;
 }
 
 /**
  * @example
  * const kManifestEmoji = Object.fromEntries(getManifestEmoji());
  */
-export function* getManifestEmoji() {
+export function* getManifestEmoji() : Generator<[string, string]> {
   for (const { emoji, title } of Object.values(FLAGS)) {
     yield [title, emoji];
   }
 }
 
-export function getEmojiFromTitle(title) {
+export function getEmojiFromTitle(title: string ) : string {
   return kManifestEmoji[title] ?? kNotFoundFlags;
 }
 
 /**
  * @description Complete list of flags title (as an ES6 Set)
  */
-export function getFlags() {
+export function getFlags(): Set<string>{
   return new Set(Object.values(FLAGS).map((flagDescriptor) => flagDescriptor.title));
 }

tsconfig.json

@@ -0,0 +1,8 @@
+{
+    "extends": "@openally/config.typescript",
+    "compilerOptions": {
+       "outDir": "dist",
+      "rootDir": "./src",
+      "types": ["node"],
+    }
+  }