anubis-ui 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,2 @@
+# anubis-ui
+Class-based css generator

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "anubis-ui",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Class-based css generator",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "style": "dist/_anubis.scss",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/HugoLMTY/anubis-ui.git"
@@ -15,5 +16,14 @@
   "bugs": {
     "url": "https://github.com/HugoLMTY/anubis-ui/issues"
   },
-  "homepage": "https://github.com/HugoLMTY/anubis-ui#readme"
+  "homepage": "https://github.com/HugoLMTY/anubis-ui#readme",
+  "devDependencies": {
+    "@types/node": "^22.14.1",
+    "typescript": "^5.8.3",
+    "vite": "^6.3.2"
+  },
+  "dependencies": {
+    "fast-glob": "^3.3.3",
+    "fs": "^0.0.1-security"
+  }
 }

package/src/config/colors.config.json

@@ -0,0 +1,9 @@
+[
+  "primary",
+  "secondary",
+  "accent",
+  "neutral",
+  "success",
+  "warning",
+  "danger"
+]

package/src/config/config.tool.ts

@@ -0,0 +1,60 @@
+import fs from 'fs'
+import path from 'path'
+import { log } from '../tools/logger'
+
+interface IPreset {
+  [key: string]: string
+}
+interface IEnvConfig {
+  files: {
+    targets: string|string[],
+    ignore: string[]
+  },
+  colors: string[],
+  selectors: {
+    states: string[],
+    prefixes: string[]
+  },
+  presets: {
+    'border': IPreset[],
+    'inner-border': IPreset[],
+    'shadow': IPreset[],
+  },
+  [key: string]: any
+}
+
+const configFolder = path.join(__dirname, '..', 'config')
+const configFiles = [
+  'files',
+  'colors',
+  'presets',
+  'selectors'
+]
+
+const config = {
+  files: { targets: [], ignore: [] },
+  colors: [],
+  selectors: { states: [], prefixes: [] },
+  presets: {
+    border: [],
+    "inner-border": [],
+    shadow: [],
+  },
+} as IEnvConfig
+
+const init = () => {
+  for (const file of configFiles) {
+    const filePath = path.join(configFolder, `${file}.config.json`)
+
+    const configContent = fs.readFileSync(filePath, { encoding: 'utf-8' })
+
+    config[file as keyof typeof config] = JSON.parse(configContent)
+  }
+
+  return config
+}
+
+export {
+  init,
+  config
+}

package/src/config/files.config.json

@@ -0,0 +1,5 @@
+{
+  "targets": [
+    "**/*.vue"
+  ]
+}

package/src/config/presets.config.json

@@ -0,0 +1,33 @@
+{
+  "border": [
+    { "default": "4px" },
+    { "thinest": "1px" },
+    { "thiner": "2px" },
+    { "thin": "3px" },
+    { "thick": "6px" },
+    { "thicker": "8px" },
+    { "thickest": "10px" },
+    { "node": "0.2rem" }
+  ],
+
+  "innerBorder": [
+    { "default": "4px" },
+    { "thinest": "1px" },
+    { "thiner": "2px" },
+    { "thin": "3px" },
+    { "thick": "6px" },
+    { "thicker": "8px" },
+    { "thickest": "10px" },
+    { "node": "0.2rem" }
+  ],
+
+  "shadow": [
+    { "default": "0px 0px 7px 1px" },
+    { "densest": "0px 0px 3px 1px" },
+    { "denser": "0px 0px 5px 1px" },
+    { "dense": "0px 0px 5px 1px" },
+    { "wide": "0px 0px 10px 1px" },
+    { "wider": "0px 0px 15px 1px" },
+    { "widest": "0px 0px 20px 1px" }
+  ]
+}

package/src/config/selectors.config.json

@@ -0,0 +1,13 @@
+{
+  "states": [
+      "hover",
+      "not-hover"
+  ],
+  "prefixes": [
+      "bg",
+      "text",
+      "border",
+      "inner-border",
+      "shadow"
+  ]
+}

package/src/config/wip_presets.config.json

@@ -0,0 +1,47 @@
+[
+  {
+    "defaultBorderRadius": "6px",
+    "borderRadiuses": [
+      { "lessest": "2px" },
+      { "lesser": "3px" },
+      { "less": "4px" },
+      { "more": "6px" },
+      { "morer": "8px" },
+      { "morest": "12px" },
+      { "half": "25%" },
+      { "full": "50%" }
+    ],
+
+    "defaultBorderWidth": "4px",
+    "borderWidths": [
+      { "thinest": "1px" },
+      { "thiner": "2px" },
+      { "thin": "3px" },
+      { "thick": "6px" },
+      { "thicker": "8px" },
+      { "thickest": "10px" },
+      { "node": "0.2rem" }
+    ],
+
+    "defaultInnerBorderWidth": "4px",
+    "innerBorderWidths": [
+      { "thinest": "1px" },
+      { "thiner": "2px" },
+      { "thin": "3px" },
+      { "thick": "6px" },
+      { "thicker": "8px" },
+      { "thickest": "10px" },
+      { "node": "0.2rem" }
+    ],
+
+    "defaultShadow": "0px 0px 7px 1px",
+    "shadowWidths": [
+      { "densest": "0px 0px 3px 1px" },
+      { "denser": "0px 0px 5px 1px" },
+      { "dense": "0px 0px 5px 1px" },
+      { "wide": "0px 0px 10px 1px" },
+      { "wider": "0px 0px 15px 1px" },
+      { "widest": "0px 0px 20px 1px" }
+    ]
+  }
+]

package/src/config/wip_selectors.config.json

@@ -0,0 +1,30 @@
+{
+  "states": [
+    {
+      "prefix": "hover",
+      "selector": ":hover"
+    },
+    {
+      "prefix": "not-hover",
+      "selector": ":not(:hover)"
+    }
+  ],
+  "prefixes": [
+    {
+      "prefix": "bg",
+      "selector": "background: ${value} !important"
+    },
+    {
+      "prefix": "border",
+      "selector": "border-width: 1px; border-style: solid; border-color: ${value} !important"
+    },
+    {
+      "prefix": "inner-border",
+      "selector": "box-shadow: inset ${value} !important"
+    },
+    {
+      "prefix": "shadow",
+      "selector": "box-shadow: ${value} !important"
+    }
+  ]
+}

package/src/index.ts

@@ -0,0 +1,43 @@
+import { Plugin } from 'vite'
+
+import { init as initConfig } from './config/config.tool'
+import { log, logo, logPrefix } from './tools/logger'
+// import { init as initPresets } from './config/'
+import { init as initClassExtraction } from './tools/extract/classes'
+
+/** List every imported colors across the projet */
+const colors: string[] = []
+
+const init = async () => {
+  console.time(`${logPrefix} Config initialized in`)
+  initConfig()
+  console.timeEnd(`${logPrefix} Config initialized in`)
+  log('---')
+
+  console.time(`${logPrefix} Rules generated in`)
+  await initClassExtraction()
+  console.timeEnd(`${logPrefix} Rules generated in`)
+  log('---')
+}
+
+export default function AnubisUI (): Plugin {
+  return {
+    name: 'anubis-ui',
+    configureServer(server: any) {
+      server.watcher.on('change', (file: any) => {
+        console.log({ file })
+      })
+    },
+    async buildStart() {
+      logo()
+
+      console.time(`${logPrefix} Anubis initialized in`)
+      await init()
+      console.timeEnd(`${logPrefix} Anubis initialized in`)
+    }
+  }
+}
+
+export {
+  colors
+}

package/src/interfaces/config.presets.interface.ts

@@ -0,0 +1,19 @@
+interface IConfigDeclaration {
+  [key: string]: string,
+}
+
+export interface IConfigPresets {
+  defaultInnerBorderWidth?: string
+  innerBorderWidths?: IConfigDeclaration[]
+
+  defaultBorderWidth?: string
+  borderWidths?: IConfigDeclaration[]
+
+  defaultShadow?: string,
+  shadowWidths?: IConfigDeclaration[]
+
+  defaultBorderRadius?: string
+  borderRadiuses?: IConfigDeclaration[]
+
+  fontWeights?: IConfigDeclaration[]
+}

package/src/interfaces/declaration.interface.ts

@@ -0,0 +1,10 @@
+export interface IDeclaration {
+  /** Color variable name, defined in the DOM :root */
+  name: string
+
+  /** Hexadecimal color code */
+  color: string|number
+
+  // light?: string
+  // dark?: string
+}

package/src/interfaces/files.interface.ts

@@ -0,0 +1,4 @@
+export interface IFileConfig {
+  targets: string|string[]
+  ignore: string[]
+}

package/src/manual/build.ts

@@ -0,0 +1,4 @@
+import AnubisUI from "..";
+
+//@ts-ignore
+AnubisUI()?.buildStart()

package/src/tools/cssFile.ts

@@ -0,0 +1,36 @@
+import fs from 'fs'
+import path from 'path'
+import { log } from './logger'
+
+const distDir = path.join(__dirname, '..', '..', 'dist')
+const outputPath = path.join(distDir, '_anubis.scss')
+
+const checkCssRuleFilePresence = () => {
+  try {
+    fs.mkdirSync(distDir, { recursive: true })
+
+    if (fs.existsSync(outputPath)) { return }
+
+    log('Output file missing, generating..')
+    fs.writeFileSync(outputPath, '')
+  } catch (err: any) {
+    throw new Error(`Erreur lors de la vérification du fichier CSS: ${err.message}`)
+  }
+}
+
+const buildCssRuleFile = (classes: string = '') => {
+  try {
+    checkCssRuleFilePresence()
+
+    fs.writeFileSync(outputPath, classes)
+
+    return outputPath
+  } catch (err: any) {
+    throw new Error(`Erreur lors de l'écriture du fichier CSS: ${err.message}`)
+  }
+}
+
+export {
+  checkCssRuleFilePresence,
+  buildCssRuleFile
+}

package/src/tools/declaration/color.ts

@@ -0,0 +1,3 @@
+import { IDeclaration } from "../../interfaces/declaration.interface";
+
+const declareColor = (options: { name: string, color: string, theme?: string }) => {}

package/src/tools/extract/classes/index.ts

@@ -0,0 +1,67 @@
+import { config } from "../../../config/config.tool"
+import { buildCssRuleFile } from "../../cssFile"
+import { log } from "../../logger"
+import { mapClassIntoRule } from "../../mapping/mapClassIntoRule"
+import { getFiles } from "../extract.tools"
+
+import fs from 'fs'
+
+/** Fetch vue file based on config target patterns */
+const init = async () => {
+  const files = await getFiles(config.files)
+  // console.log({ files })
+
+  const uniqueClasses = await getUniqueClasses(files)
+  const mappedRules = mapClassesIntoRules(uniqueClasses)
+  // console.log({ uniqueClasses, mappedRules })
+
+  const file = buildCssRuleFile(mappedRules)
+  // console.log({ file })
+}
+
+/** Extract detected class and map into a flat set */
+const getUniqueClasses = async (files: string[]): Promise<string[]> => {
+  const extractedClasses = (await Promise.all(
+    files.map(async file => extractClasses(file))
+  ))
+  ?.flat()
+  ?.sort()
+
+  const uniqueClasses = Array.from(new Set(extractedClasses))
+  // log(`${uniqueClasses?.length} classes found`)
+
+  return uniqueClasses
+}
+
+/** Find matching classes from a given file based on config states and prefixes */
+const extractClasses = async (filePath: string): Promise<string[]> => {
+  const file = await fs.promises.readFile(filePath, 'utf-8')
+  if (!file) { return [] }
+
+  const { states, prefixes } = config.selectors
+
+  const partialStates = `(${states?.map(s => `${s}:`)?.join('|')})`
+  const partialPrefixes = `(${prefixes?.map(p => `${p}-`)?.join('|')})`
+
+  const classDetectionRegex = new RegExp(`${partialStates}?${partialPrefixes}(\\w+(-+)?)+`, 'gi')
+
+  const matches = file.match(classDetectionRegex)
+  if (!matches?.length) { return [] }
+
+  return matches
+}
+
+const mapClassesIntoRules = (classes: string[]) => {
+  const mappedRules = classes
+    ?.map(cssClass => mapClassIntoRule(cssClass))
+    ?.filter(rule => rule)
+
+  log(`${mappedRules?.length} rules generated`)
+
+  const rules = mappedRules?.join('\n')
+  return rules
+}
+
+export {
+  init
+}

package/src/tools/extract/extract.tools.ts

@@ -0,0 +1,16 @@
+import fg from 'fast-glob'
+import fs from 'fs'
+
+import { IFileConfig } from '../../interfaces/files.interface'
+
+const getFiles = async (routeConfig: IFileConfig) => {
+  return await fg(routeConfig.targets || '*.vue', {
+    absolute: true,
+    onlyFiles: true,
+    ignore: routeConfig.ignore || [],
+  })
+}
+
+export {
+  getFiles
+}

package/src/tools/logger.ts

@@ -0,0 +1,21 @@
+const logPrefix = '☯︎ [ANUBIS]'
+const log = (str: string) => console.log(`${logPrefix} ${str}`)
+
+const logo = () => {
+  log('    ___    _   ____  ______  _________')
+  log('   /   |  / | / / / / / __ )/  _/ ___/')
+  log('  / /| | /  |/ / / / / __  |/ / \\__ \\')
+  log(' / ___ |/ /|  / /_/ / /_/ // / ___/ /')
+  log('/_/  |_/_/ |_/\\____/_____/___//____/')
+  log('')
+  log('Welcome to Anubis 1.0')
+  log('Autonomous Nominative Utility Based Intuitive Styler')
+  log('---')
+}
+
+export {
+  logo,
+
+  log,
+  logPrefix
+}

package/src/tools/mapping/mapClassIntoRule.ts

@@ -0,0 +1,155 @@
+import { config } from "../../config/config.tool"
+
+const mapClassIntoRule = (stringClass: string) => {
+  const colorExists = config.colors?.some(color => stringClass.includes(color))
+  if (!colorExists) { return }
+
+  const params = getClassInfos(stringClass)
+  // console.log({ params })
+
+  const rule = mapIntoRule(params)
+  // console.log({ rule })
+
+  return rule
+}
+
+const getClassInfos = (stringClass: string): { state?: string, prefix?: string, color: string, variation?: { key: string, value: string } } => {
+  const { cleanedClass, state } = getStateInfos(stringClass)
+  const { cleanedColor, prefix } = getPrefixInfos(cleanedClass)
+  const { color, variation } = getVariantInfos({ cleanedColor, prefix })
+
+  // console.log({ state, color, prefix, variation })
+  return { state, color, prefix, variation }
+}
+
+const getStateInfos = (stringClass: string) => {
+  let state = undefined
+
+  for (const configState of config.selectors?.states) {
+    if (!stringClass.startsWith(configState)) { continue }
+
+    state = configState
+  }
+
+  const cleanedClass = !!state ? stringClass?.slice(state?.length + 1) : stringClass
+  return {
+    cleanedClass,
+    state,
+  }
+}
+
+const getPrefixInfos = (stringClass: string): { cleanedColor: string, prefix: string } => {
+  let prefix = ''
+
+  for (const configPrefix of config.selectors.prefixes) {
+    if (!stringClass.startsWith(configPrefix)) { continue }
+
+    prefix = configPrefix
+  }
+
+  return {
+    cleanedColor: stringClass?.slice(prefix.length + 1),
+    prefix,
+  }
+}
+
+const getVariantInfos = ({ cleanedColor, prefix }: { cleanedColor: string, prefix?: string }): { color: string, variation?: { key: string, value: string } } => {
+  // _ Handle opacity | bg-primary-10
+  const opacityDetectionRegex = new RegExp(/(?:(\w-?)+)-\d{2}$/, 'gm') // Strings that end with two digits
+  const isOpacity = opacityDetectionRegex.test(cleanedColor)
+  if (isOpacity) {
+    return {
+      color: cleanedColor?.slice(0, -3),
+      variation: {
+        key: 'opacity',
+        value: cleanedColor?.slice(-2),
+      }
+    }
+  }
+
+  // _ Find preset variants matching the prefix from the config
+  const variants = config.presets[prefix as keyof typeof config.presets]
+  if (!variants) { return { color: cleanedColor } }
+
+  // _ Map found variants into a key/value object
+  const matchingVariants = variants
+    ?.map(v => Object.entries(v))
+    ?.flat()
+    ?.map(([key, value]) => ({ key, value }))
+    // ?.filter(({ key }) => key !== 'default')
+
+  const variation = matchingVariants?.find(({ key }) => cleanedColor.endsWith(key)) || matchingVariants?.find(({ key }) => key === 'default')
+  // console.log({ variation })
+
+  const color = variation && variation.key !== 'default'
+    ? cleanedColor?.slice(0, variation.key.length + 1)
+    : cleanedColor
+
+  return {
+    color,
+    variation
+  }
+}
+
+function mapIntoRule({ state, prefix, color, variation }: { state?: string, prefix?: string, color: string, variation?: { key: string, value: string } }) {  
+  const colorVar = `var(--${color})`
+
+  // _ Set state selector
+  let stateSelector = ''
+  switch (state) {
+    case 'hover':
+      stateSelector = ':hover'
+      break
+
+    case 'not-hover':
+      stateSelector = ':not(:hover)'
+      break
+  }
+
+  let declaration = ''
+
+  // _ Set prefix declaration
+  // ! Don't forget to add the prefix in the selector.config root file
+  switch (prefix) {
+    case 'bg':
+      declaration = `background: ${colorVar} !important`
+      break
+
+    case 'text':
+      declaration = `color: ${colorVar} !important`
+      break
+
+    case 'border':
+      declaration = `border-width: ${variation?.value} !important; border-color: ${colorVar} !important; border-style: solid`
+      break
+
+    case 'inner-border':
+      declaration = `box-shadow: inset ${variation?.value} ${colorVar} !important`
+      break
+
+    case 'shadow':
+      declaration = `box-shadow: ${variation?.value} ${colorVar} !important`
+      break
+
+    default:
+      // _ custom rule from config file
+      const customDeclaration = config.customRules?.find((r: any) => r.prefix === prefix)?.declaration
+      if (!customDeclaration) { return }
+
+      declaration = customDeclaration?.replace('${value}', color) + ' !important'
+      break
+  }
+
+  let selector = `${prefix}-${color}`
+  if (state) {
+    selector = `${state}\\:${selector}${stateSelector}`
+  }
+
+  const rule = `.${selector} { ${declaration} }`
+
+  return rule
+}
+
+export {
+  mapClassIntoRule
+}

package/template/colors.js

@@ -0,0 +1,5 @@
+const colors = [
+  { name: 'primary', color: '#0f84cb' },
+  { name: 'secondary', color: '#3b5161' },
+  { name: 'accent', color: '#0f84cb' },
+]

package/tsconfig.json

@@ -1,3 +1,113 @@
-"scripts": {
-  "build": "tsc"
-}
+{
+  "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. */
+    // "libReplacement": true,                           /* Enable lib replacement. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental 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": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* 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. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "rewriteRelativeImportExtensions": true,          /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "noUncheckedSideEffectImports": true,             /* Check side effect imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'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. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "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. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "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. */
+    // "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. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+    // "erasableSyntaxOnly": true,                       /* Do not allow runtime constructs that are not part of ECMAScript. */
+    // "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. */
+    // "strictBuiltinIteratorReturn": true,              /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
+    // "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. */
+  }
+}