@stacksjs/dtsx 0.8.2 → 0.9.2

package/dist/types.d.ts

@@ -1,3 +1,8 @@
+/**
+ * DtsGenerationConfig
+ *
+ * This is the configuration object for the DTS generation process.
+ */
 export declare interface DtsGenerationConfig {
   cwd: string
   root: string
@@ -9,108 +14,76 @@ export declare interface DtsGenerationConfig {
   verbose: boolean | string[]
   outputStructure?: 'mirror' | 'flat'
 }
-export declare type DtsGenerationOption = Partial<DtsGenerationConfig>
-
-export type DtsGenerationOptions = DtsGenerationOption | DtsGenerationOption[]
-
-export interface RegexPatterns {
-  readonly typeImport: RegExp
-  readonly regularImport: RegExp
-  readonly bracketOpen: RegExp
-  readonly bracketClose: RegExp
-  readonly functionReturn: RegExp
-  readonly typeAnnotation: RegExp
-  readonly asyncFunction: RegExp
-  readonly genericParams: RegExp
-  readonly functionParams: RegExp
-  readonly functionReturnType: RegExp
-  readonly destructuredParams: RegExp
-  readonly typePattern: RegExp
-  readonly valueReference: RegExp
-  readonly typeReference: RegExp
-  readonly functionName: RegExp
-  readonly exportCleanup: RegExp
-  readonly defaultExport: RegExp
-  readonly complexType: RegExp
-  readonly unionIntersection: RegExp
-  readonly mappedType: RegExp
-  readonly conditionalType: RegExp
-  readonly genericConstraints: RegExp
-  readonly functionOverload: RegExp
-  readonly moduleDeclaration: RegExp
-  readonly moduleAugmentation: RegExp
-}
-
-export interface ImportTrackingState {
-  typeImports: Map<string, Set<string>> 
-  valueImports: Map<string, Set<string>> 
-  usedTypes: Set<string> 
-  usedValues: Set<string> 
-  exportedTypes: Set<string> 
-  exportedValues: Set<string> 
-  valueAliases: Map<string, string> 
-  importSources: Map<string, string> 
-  typeExportSources: Map<string, string> 
-  defaultExportValue?: string 
-}
-
-export interface ProcessingState {
-  dtsLines: string[]
-  imports: string[]
-  usedTypes: Set<string>
-  typeSources: Map<string, string>
-  defaultExport: string | null
-  exportAllStatements: string[]
-  currentDeclaration: string
-  lastCommentBlock: string
-  bracketCount: number
-  isMultiLineDeclaration: boolean
-  moduleImports: Map<string, ImportInfo>
-  availableTypes: Map<string, string>
-  availableValues: Map<string, string>
-  currentIndentation: string
-  declarationBuffer: {
-    type: 'interface' | 'type' | 'const' | 'function' | 'import' | 'export'
-    indent: string
-    lines: string[]
-    comments: string[]
-  } | null
-  importTracking: ImportTrackingState
-  defaultExports: Set<string>
-  currentScope: 'top' | 'function'
+/**
+ * Declaration
+ *
+ * Represents a parsed declaration from TypeScript source
+ */
+export declare interface Declaration {
+  kind: 'function' | 'variable' | 'interface' | 'type' | 'class' | 'enum' | 'import' | 'export' | 'module'
+  name: string
+  text: string
+  leadingComments?: string[]
+  isExported: boolean
+  isDefault?: boolean
+  typeAnnotation?: string
+  modifiers?: string[]
+  generics?: string
+  extends?: string
+  implements?: string[]
+  members?: Declaration[]
+  parameters?: ParameterDeclaration[]
+  returnType?: string
+  value?: any
+  source?: string
+  specifiers?: ImportSpecifier[]
+  isTypeOnly?: boolean
+  isAsync?: boolean
+  isGenerator?: boolean
+  overloads?: string[]
+  start?: number
+  end?: number
 }
-
-export interface MethodSignature {
+/**
+ * ParameterDeclaration
+ */
+export declare interface ParameterDeclaration {
   name: string
-  async: boolean
-  generics: string
-  params: string
-  returnType: string
+  type?: string
+  optional?: boolean
+  rest?: boolean
+  defaultValue?: string
 }
-
-export interface PropertyInfo {
-  key: string
-  value: string
-  type: string
-  nested?: PropertyInfo[]
-  method?: MethodSignature
+/**
+ * ImportSpecifier
+ */
+export declare interface ImportSpecifier {
+  name: string
+  alias?: string
+  isType?: boolean
 }
-
-export interface ImportInfo {
-  kind: 'type' | 'value' | 'mixed'
+/**
+ * ProcessingContext
+ *
+ * Context passed through processing pipeline
+ */
+export declare interface ProcessingContext {
+  filePath: string
+  sourceCode: string
+  declarations: Declaration[]
+  imports: Map<string, Set<string>>
+  exports: Set<string>
   usedTypes: Set<string>
-  usedValues: Set<string>
-  source: string
-}
-
-export interface FunctionSignature {
-  name: string
-  params: string
-  returnType: string
-  generics: string
 }
-
-export interface ProcessedMethod {
-  name: string
-  signature: string
-}
+/**
+ * DtsGenerationOption
+ *
+ * This is the configuration object for the DTS generation process.
+ */
+export type DtsGenerationOption = Partial<DtsGenerationConfig>
+/**
+ * DtsGenerationOptions
+ *
+ * This is the configuration object for the DTS generation process.
+ */
+export type DtsGenerationOptions = DtsGenerationOption | DtsGenerationOption[]

package/dist/utils.d.ts

@@ -1,6 +1,5 @@
 import type { DtsGenerationConfig } from './types';
-
 export declare function writeToFile(filePath: string, content: string): Promise<void>;
 export declare function getAllTypeScriptFiles(directory?: string): Promise<string[]>;
-export declare function checkIsolatedDeclarations(options?: DtsGenerationConfig): Promise<boolean>;
-declare function makeAbsolute(basePath: string, configPath: string): string;
+// only checks for 2 potentially nested levels
+export declare function checkIsolatedDeclarations(options?: DtsGenerationConfig): Promise<boolean>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/dtsx",
   "type": "module",
-  "version": "0.8.2",
+  "version": "0.9.2",
   "description": "A modern, fast .d.ts generation tool, powered by Bun.",
   "author": "Chris Breuer <chris@stacksjs.org>",
   "license": "MIT",
@@ -25,16 +25,16 @@
   ],
   "exports": {
     ".": {
-      "import": "./dist/index.js"
+      "import": "./dist/src/index.js"
     },
     "./*": {
       "import": "./dist/*"
     }
   },
-  "module": "./dist/index.js",
+  "module": "./dist/src/index.js",
   "types": "./dist/index.d.ts",
   "bin": {
-    "dtsx": "./dist/cli.js"
+    "dtsx": "./dist/bin/cli.js"
   },
   "files": [
     "dist"
@@ -56,9 +56,6 @@
     "release": "bun run changelog && bunx bumpp package.json --all",
     "test": "bun test",
     "typecheck": "bunx tsc --noEmit",
-    "dev:docs": "bun --bun vitepress dev docs",
-    "build:docs": "bun --bun vitepress build docs",
-    "preview:docs": "bun --bun vitepress preview docs",
     "zip": "bun run zip:all",
     "zip:all": "bun run zip:linux-x64 && bun run zip:linux-arm64 && bun run zip:windows-x64 && bun run zip:darwin-x64 && bun run zip:darwin-arm64",
     "zip:linux-x64": "zip -j bin/dtsx-linux-x64.zip bin/dtsx-linux-x64",
@@ -68,23 +65,14 @@
     "zip:darwin-arm64": "zip -j bin/dtsx-darwin-arm64.zip bin/dtsx-darwin-arm64"
   },
   "devDependencies": {
-    "@stacksjs/cli": "^0.70.23",
-    "@stacksjs/development": "^0.70.23",
-    "@stacksjs/docs": "^0.70.23",
-    "@stacksjs/eslint-config": "^4.10.2-beta.3",
-    "@types/bun": "^1.2.12",
-    "bun-plugin-dtsx": "^0.21.12",
-    "bunfig": "^0.8.5",
-    "tinyglobby": "^0.2.13",
-    "unocss": "^66.1.1"
+    "bunfig": "^0.10.0",
+    "tinyglobby": "^0.2.13"
   },
-  "overrides": {
-    "unconfig": "0.3.10"
-  },
-  "simple-git-hooks": {
-    "pre-commit": "bunx lint-staged"
-  },
-  "lint-staged": {
-    "*.{js,ts}": "bunx eslint . --fix"
+  "git-hooks": {
+    "pre-commit": {
+      "staged-lint": {
+        "*.{js,ts,json,yaml,yml,md}": "bunx --bun eslint . --fix"
+      }
+    }
   }
 }

package/LICENSE.md

@@ -1,21 +0,0 @@
-# MIT License
-
-Copyright (c) 2024 Open Web Foundation
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/README.md

@@ -1,192 +0,0 @@
-<p align="center"><img src="https://github.com/stacksjs/dtsx/blob/main/.github/art/cover.jpg?raw=true" alt="Social Card of this repo"></p>
-
-[![npm version][npm-version-src]][npm-version-href]
-[![GitHub Actions][github-actions-src]][github-actions-href]
-[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
-<!-- [![npm downloads][npm-downloads-src]][npm-downloads-href] -->
-<!-- [![Codecov][codecov-src]][codecov-href] -->
-
-# dtsx
-
-> A library that helps you generate TypeScript declaration files from your project. Given we do not know the user's input ever, we need to never hardcode based results based from our examples, always create a dynamic solution.
-
-## Features
-
-- ⚡ Extremely fast .d.ts generation
-- ⚙️ Highly configurable
-- 🪶 Lightweight library
-- 🤖 Cross-platform binary
-
-## Install
-
-```bash
-bun install -d @stacksjs/dtsx
-```
-
-<_@npmjs.com>, please allow us to use the `dtsx` package name 🙏_
-
-<!-- _Alternatively, you can install:_
-
-```bash
-brew install dtsx # wip
-pkgx install dtsx # wip
-``` -->
-
-## Get Started
-
-There are two ways of using this ".d.ts generation" tool: _as a library or as a CLI._
-
-_But before you get started, please ensure you enabled `isolatedDeclarations` in your `tsconfig.json` file._
-
-```json
-{
-  "compilerOptions": {
-    "isolatedDeclarations": true
-  }
-}
-```
-
-## Library
-
-Given the npm package is installed, you can use the `generate` function to generate TypeScript declaration files from your project.
-
-### Usage
-
-```ts
-import type { DtsGenerationOptions } from '@stacksjs/dtsx'
-import { generate } from '@stacksjs/dtsx'
-
-const options: DtsGenerationOptions = {
-  cwd: './', // default: process.cwd()
-  root: './src', // default: './src'
-  entrypoints: ['**/*.ts'], // default: ['**/*.ts']
-  outdir: './dist', // default: './dist'
-  clean: true, // default: false
-  verbose: true, // default: false
-  // keepComments: true, // coming soon
-}
-
-await generate(options)
-```
-
-_Available options:_
-
-Library usage can also be configured using a `dts.config.ts` _(or `dts.config.js`)_ file which is automatically loaded when running the `./dtsx` _(or `bunx dtsx`)_ command. It is also loaded when the `generate` function is called, unless custom options are provided.
-
-```ts
-// dts.config.ts (or dts.config.js)
-
-export default {
-  cwd: './',
-  root: './src',
-  entrypoints: ['**/*.ts'],
-  outdir: './dist',
-  keepComments: true,
-  clean: true,
-  verbose: true,
-}
-```
-
-_You may also run:_
-
-```bash
-./dtsx generate
-
-# if the package is installed, you can also run:
-# bunx dtsx generate
-```
-
-## CLI
-
-The `dtsx` CLI provides a simple way to generate TypeScript declaration files from your project. Here's how to use it:
-
-### Usage
-
-Generate declaration files using the default options:
-
-```bash
-dtsx generate
-```
-
-_Or use custom options:_
-
-```bash
-# Generate declarations for specific entry points:
-dtsx generate --entrypoints src/index.ts,src/utils.ts --outdir dist/types
-
-# Generate declarations with custom configuration:
-dtsx generate --root ./lib --outdir ./types --clean
-
-dtsx --help
-dtsx --version
-```
-
-_Available options:_
-
-- `--cwd <path>`: Set the current working directory _(default: current directory)_
-- `--root <path>`: Specify the root directory of the project _(default: './src')_
-- `--entrypoints <files>`: Define entry point files _(comma-separated, default: '**/*.ts')_
-- `--outdir <path>`: Set the output directory for generated .d.ts files _(default: './dist')_
-- `--keep-comments`: Keep comments in generated .d.ts files _(default: true)_
-- `--clean`: Clean output directory before generation _(default: false)_
-- `--tsconfig <path>`: Specify the path to tsconfig.json _(default: 'tsconfig.json')_
-- `--verbose`: Enable verbose output _(default: false)_
-
-To learn more, head over to the [documentation](https://dtsx.stacksjs.org/).
-
-## Testing
-
-```bash
-bun test
-```
-
-## Changelog
-
-Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
-
-## Contributing
-
-Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
-
-## Community
-
-For help, discussion about best practices, or any other conversation that would benefit from being searchable:
-
-[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
-
-For casual chit-chat with others using this package:
-
-[Join the Stacks Discord Server](https://discord.gg/stacksjs)
-
-## Postcardware
-
-“Software that is free, but hopes for a postcard.” We love receiving postcards from around the world showing where `dtsx` is being used! We showcase them on our website too.
-
-Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎
-
-## Sponsors
-
-We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.
-
-- [JetBrains](https://www.jetbrains.com/)
-- [The Solana Foundation](https://solana.com/)
-
-## Credits
-
-- [Chris Breuer](https://github.com/chrisbbreuer)
-- [All Contributors](../../contributors)
-
-## License
-
-The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/dtsx/tree/main/LICENSE.md) for more information.
-
-Made with 💙
-
-<!-- Badges -->
-[npm-version-src]: https://img.shields.io/npm/v/@stacksjs/dtsx?style=flat-square
-[npm-version-href]: https://npmjs.com/package/@stacksjs/dtsx
-[github-actions-src]: https://img.shields.io/github/actions/workflow/status/stacksjs/dtsx/ci.yml?style=flat-square&branch=main
-[github-actions-href]: https://github.com/stacksjs/dtsx/actions?query=workflow%3Aci
-
-<!-- [codecov-src]: https://img.shields.io/codecov/c/gh/stacksjs/dtsx/main?style=flat-square
-[codecov-href]: https://codecov.io/gh/stacksjs/dtsx -->