From 81fc79a09095cd4b1a764091eb608c8a4bb5b720 Mon Sep 17 00:00:00 2001 From: William Cory Date: Sat, 31 Aug 2024 13:57:34 -0700 Subject: [PATCH] :recycle: Regenerate --- bundler-packages/base-bundler/docs/README.md | 4 +- .../base-bundler/docs/_media/LICENSE | 22 --- .../base-bundler/docs/_media/bundler.md | 142 ------------------ .../base-bundler/docs/functions/bundler.md | 26 ---- bundler-packages/bundler-cache/docs/README.md | 2 +- .../bundler-cache/docs/_media/LICENSE | 22 --- .../docs/functions/createCache.md | 2 - bundler-packages/compiler/docs/README.md | 2 +- bundler-packages/compiler/docs/_media/LICENSE | 22 --- bundler-packages/config/docs/README.md | 2 +- bundler-packages/config/docs/_media/LICENSE | 22 --- .../defineConfig/classes/DefineConfigError.md | 8 +- .../defineConfig/functions/defineConfig.md | 13 -- .../loadConfig/classes/LoadConfigError.md | 8 +- .../docs/loadConfig/functions/loadConfig.md | 13 -- bundler-packages/resolutions/docs/README.md | 4 +- .../resolutions/docs/_media/LICENSE | 22 --- .../moduleFactory/functions/moduleFactory.md | 35 ----- .../functions/resolveImports.md | 22 --- bundler-packages/runtime/docs/README.md | 6 +- bundler-packages/runtime/docs/_media/LICENSE | 22 --- bundler-packages/solc/docs/README.md | 2 +- bundler-packages/solc/docs/_media/LICENSE | 22 --- .../solc/docs/functions/solcCompile.md | 2 - packages/effect/docs/README.md | 2 +- packages/effect/docs/_media/LICENSE | 22 --- .../classes/CreateRequireError.md | 8 +- .../classes/RequireError.md | 8 +- .../functions/createRequireEffect.md | 16 -- .../docs/fileExists/functions/fileExists.md | 9 -- .../logAllErrors/functions/logAllErrors.md | 11 -- .../docs/parseJson/classes/ParseJsonError.md | 8 +- .../docs/parseJson/functions/parseJson.md | 13 -- .../classes/CouldNotResolveImportError.md | 8 +- .../docs/resolve/functions/resolveAsync.md | 10 -- .../docs/resolve/functions/resolveSync.md | 11 -- 36 files changed, 36 insertions(+), 537 deletions(-) delete mode 100644 bundler-packages/base-bundler/docs/_media/LICENSE delete mode 100644 bundler-packages/base-bundler/docs/_media/bundler.md delete mode 100644 bundler-packages/bundler-cache/docs/_media/LICENSE delete mode 100644 bundler-packages/compiler/docs/_media/LICENSE delete mode 100644 bundler-packages/config/docs/_media/LICENSE delete mode 100644 bundler-packages/resolutions/docs/_media/LICENSE delete mode 100644 bundler-packages/runtime/docs/_media/LICENSE delete mode 100644 bundler-packages/solc/docs/_media/LICENSE delete mode 100644 packages/effect/docs/_media/LICENSE diff --git a/bundler-packages/base-bundler/docs/README.md b/bundler-packages/base-bundler/docs/README.md index 4ba1705b7d..e47215122a 100644 --- a/bundler-packages/base-bundler/docs/README.md +++ b/bundler-packages/base-bundler/docs/README.md @@ -43,8 +43,8 @@ And all bundlers ## Usage -See [docs](_media/bundler.md) +See [docs]() ## License 📄 - + diff --git a/bundler-packages/base-bundler/docs/_media/LICENSE b/bundler-packages/base-bundler/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/bundler-packages/base-bundler/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -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. diff --git a/bundler-packages/base-bundler/docs/_media/bundler.md b/bundler-packages/base-bundler/docs/_media/bundler.md deleted file mode 100644 index 07ce152621..0000000000 --- a/bundler-packages/base-bundler/docs/_media/bundler.md +++ /dev/null @@ -1,142 +0,0 @@ -[**@tevm/base-bundler**](../README.md) • **Docs** - -*** - -[@tevm/base-bundler](../globals.md) / bundler - -# Function: bundler() - -> **bundler**(`config`, `logger`, `fao`, `solc`, `cache`, `contractPackage`?): `object` - -The base bundler instance used within tevm to generate JavaScript and TypeScript files -from solidity files. This is used internally by all other tevm build tooling including -the ts-plugin, the webpack plugin, the bun plugin, the vite plugin, and more. - -## Parameters - -• **config**: `ResolvedCompilerConfig` - -The tevm config. Can be loaded with `loadConfig()` - -• **logger**: `Logger` - -The logger to use for logging. Can be `console` - -• **fao**: `FileAccessObject` - -The file access object to use for reading and writing files. Can use fs to fill this out - -• **solc**: `any` - -The solc compiler to use. Can be loaded with `createSolc()` - -• **cache**: `Cache` - -The cache to use. Can be created with `createCache()` - -• **contractPackage?**: `"tevm/contract"` \| `"@tevm/contract"` - -The name of the package that contains the contract package -If not included the bundler will attempt to autodetect the package - -## Returns - -`object` - -### config - -> **config**: `ResolvedCompilerConfig` - -The configuration of the plugin. - -### exclude? - -> `optional` **exclude**: `string`[] - -### include? - -> `optional` **include**: `string`[] - -### name - -> **name**: `string` - -The name of the plugin. - -### resolveCjsModule - -> **resolveCjsModule**: `AsyncBundlerResult` - -Resolves cjs representation of the solidity module - -### resolveCjsModuleSync - -> **resolveCjsModuleSync**: `SyncBundlerResult` - -Resolves cjs representation of the solidity module - -### resolveDts - -> **resolveDts**: `AsyncBundlerResult` - -Resolves .d.ts representation of the solidity module - -### resolveDtsSync - -> **resolveDtsSync**: `SyncBundlerResult` - -Resolves .d.ts representation of the solidity module - -### resolveEsmModule - -> **resolveEsmModule**: `AsyncBundlerResult` - -Resolves the esm representation of the solidity module - -### resolveEsmModuleSync - -> **resolveEsmModuleSync**: `SyncBundlerResult` - -Resolves the esm representation of the solidity module - -### resolveTsModule - -> **resolveTsModule**: `AsyncBundlerResult` - -Resolves typescript representation of the solidity module - -### resolveTsModuleSync - -> **resolveTsModuleSync**: `SyncBundlerResult` - -Resolves typescript representation of the solidity module - -## Example - -```typescript -import { bundler } from '@tevm/base-bundler-bundler' -import { createCache } from '@tevm/bundler-cache' -import { readFile, writeFile } from 'fs/promises' -import { readFileSync, writeFileSync, existsSync } from 'fs' -import { createSolc } from '@tevm/solc' -import { loadConfig } from '@tevm/config' - -const fao = { - readFile, - writeFile, - readFileSync, - writeFileSync, - existsSync, - // may need more methods -} - -const b = bundler(await loadConfig(), console, fao, await createSolc(), createCache()) - -const path = '../contracts/ERC20.sol' - -const { abi, bytecode } = await b.resolveTs(path, __dirname, true, true) -``` - -## Defined in - -[bundler.js:45](https://github.com/evmts/tevm-monorepo/blob/main/bundler-packages/base-bundler/src/bundler.js#L45) diff --git a/bundler-packages/base-bundler/docs/functions/bundler.md b/bundler-packages/base-bundler/docs/functions/bundler.md index 07ce152621..310e48c312 100644 --- a/bundler-packages/base-bundler/docs/functions/bundler.md +++ b/bundler-packages/base-bundler/docs/functions/bundler.md @@ -111,32 +111,6 @@ Resolves typescript representation of the solidity module Resolves typescript representation of the solidity module -## Example - -```typescript -import { bundler } from '@tevm/base-bundler-bundler' -import { createCache } from '@tevm/bundler-cache' -import { readFile, writeFile } from 'fs/promises' -import { readFileSync, writeFileSync, existsSync } from 'fs' -import { createSolc } from '@tevm/solc' -import { loadConfig } from '@tevm/config' - -const fao = { - readFile, - writeFile, - readFileSync, - writeFileSync, - existsSync, - // may need more methods -} - -const b = bundler(await loadConfig(), console, fao, await createSolc(), createCache()) - -const path = '../contracts/ERC20.sol' - -const { abi, bytecode } = await b.resolveTs(path, __dirname, true, true) -``` - ## Defined in [bundler.js:45](https://github.com/evmts/tevm-monorepo/blob/main/bundler-packages/base-bundler/src/bundler.js#L45) diff --git a/bundler-packages/bundler-cache/docs/README.md b/bundler-packages/bundler-cache/docs/README.md index cd9589803f..ea1b97ea4a 100644 --- a/bundler-packages/bundler-cache/docs/README.md +++ b/bundler-packages/bundler-cache/docs/README.md @@ -39,4 +39,4 @@ This package may break on minor releases and is meant to only be used within the ## License 📄 - + diff --git a/bundler-packages/bundler-cache/docs/_media/LICENSE b/bundler-packages/bundler-cache/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/bundler-packages/bundler-cache/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -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. diff --git a/bundler-packages/bundler-cache/docs/functions/createCache.md b/bundler-packages/bundler-cache/docs/functions/createCache.md index ad5c05823d..865e04fcf5 100644 --- a/bundler-packages/bundler-cache/docs/functions/createCache.md +++ b/bundler-packages/bundler-cache/docs/functions/createCache.md @@ -8,8 +8,6 @@ > **createCache**(`cacheDir`, `fs`, `cwd`): [`Cache`](../type-aliases/Cache.md) -Creates a Tevm cache object for reading and writing cached items - ## Parameters • **cacheDir**: `string` diff --git a/bundler-packages/compiler/docs/README.md b/bundler-packages/compiler/docs/README.md index 19d6520398..613fd7db9f 100644 --- a/bundler-packages/compiler/docs/README.md +++ b/bundler-packages/compiler/docs/README.md @@ -30,4 +30,4 @@ The tevm compiler for compiling Solidity files into ABI bytecode source maps and ## License 📄 - + diff --git a/bundler-packages/compiler/docs/_media/LICENSE b/bundler-packages/compiler/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/bundler-packages/compiler/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -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. diff --git a/bundler-packages/config/docs/README.md b/bundler-packages/config/docs/README.md index 4a37643e61..e3370d2cdf 100644 --- a/bundler-packages/config/docs/README.md +++ b/bundler-packages/config/docs/README.md @@ -38,4 +38,4 @@ Tools for configuring `tevm.config.ts` file. ## License 📄 - + diff --git a/bundler-packages/config/docs/_media/LICENSE b/bundler-packages/config/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/bundler-packages/config/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -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. diff --git a/bundler-packages/config/docs/defineConfig/classes/DefineConfigError.md b/bundler-packages/config/docs/defineConfig/classes/DefineConfigError.md index ea587b95ca..22e674b358 100644 --- a/bundler-packages/config/docs/defineConfig/classes/DefineConfigError.md +++ b/bundler-packages/config/docs/defineConfig/classes/DefineConfigError.md @@ -110,6 +110,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -120,10 +124,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `Error.prepareStackTrace` diff --git a/bundler-packages/config/docs/defineConfig/functions/defineConfig.md b/bundler-packages/config/docs/defineConfig/functions/defineConfig.md index 82f0d067ff..a6d030aa55 100644 --- a/bundler-packages/config/docs/defineConfig/functions/defineConfig.md +++ b/bundler-packages/config/docs/defineConfig/functions/defineConfig.md @@ -30,19 +30,6 @@ Typesafe way to create an Tevm CompilerConfig `Effect`\<`never`, [`DefineConfigError`](../classes/DefineConfigError.md), [`ResolvedCompilerConfig`](../../types/type-aliases/ResolvedCompilerConfig.md)\> -## Example - -```ts -import { defineConfig } from '@tevm/ts-plugin' - -export default defineConfig(() => ({ - lib: ['lib'], - remappings: { - 'foo': 'foo/bar' - } -}) -``` - ## Defined in [bundler-packages/config/src/defineConfig.js:48](https://github.com/evmts/tevm-monorepo/blob/main/bundler-packages/config/src/defineConfig.js#L48) diff --git a/bundler-packages/config/docs/loadConfig/classes/LoadConfigError.md b/bundler-packages/config/docs/loadConfig/classes/LoadConfigError.md index c0df386efa..1490d7247c 100644 --- a/bundler-packages/config/docs/loadConfig/classes/LoadConfigError.md +++ b/bundler-packages/config/docs/loadConfig/classes/LoadConfigError.md @@ -110,6 +110,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -120,10 +124,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `Error.prepareStackTrace` diff --git a/bundler-packages/config/docs/loadConfig/functions/loadConfig.md b/bundler-packages/config/docs/loadConfig/functions/loadConfig.md index cd8626229f..0aa15a8fb7 100644 --- a/bundler-packages/config/docs/loadConfig/functions/loadConfig.md +++ b/bundler-packages/config/docs/loadConfig/functions/loadConfig.md @@ -8,8 +8,6 @@ > **loadConfig**(`configFilePath`): `Effect`\<`never`, [`LoadConfigError`](../classes/LoadConfigError.md), [`ResolvedCompilerConfig`](../../types/type-aliases/ResolvedCompilerConfig.md)\> -Loads an Tevm config from the given path - ## Parameters • **configFilePath**: `string` @@ -18,17 +16,6 @@ Loads an Tevm config from the given path `Effect`\<`never`, [`LoadConfigError`](../classes/LoadConfigError.md), [`ResolvedCompilerConfig`](../../types/type-aliases/ResolvedCompilerConfig.md)\> -## Example - -```ts -import {tap} from 'effect/Effect' -import {loadConfig} from '@tevm/config' - -runPromise(loadConfig('./tsconfig.json')).pipe( - tap(config => console.log(config)) -) -``` - ## Defined in [bundler-packages/config/src/loadConfig.js:55](https://github.com/evmts/tevm-monorepo/blob/main/bundler-packages/config/src/loadConfig.js#L55) diff --git a/bundler-packages/resolutions/docs/README.md b/bundler-packages/resolutions/docs/README.md index 8dbbb6b930..c25470b5b6 100644 --- a/bundler-packages/resolutions/docs/README.md +++ b/bundler-packages/resolutions/docs/README.md @@ -28,8 +28,8 @@ Package to resolve the import graph for solidity packages -Generated docs at [./docs](./docs) +Generated docs at [./docs]() ## License 📄 - + diff --git a/bundler-packages/resolutions/docs/_media/LICENSE b/bundler-packages/resolutions/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/bundler-packages/resolutions/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -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. diff --git a/bundler-packages/resolutions/docs/moduleFactory/functions/moduleFactory.md b/bundler-packages/resolutions/docs/moduleFactory/functions/moduleFactory.md index 1957d28b77..6b0633a334 100644 --- a/bundler-packages/resolutions/docs/moduleFactory/functions/moduleFactory.md +++ b/bundler-packages/resolutions/docs/moduleFactory/functions/moduleFactory.md @@ -8,16 +8,6 @@ > **moduleFactory**(`absolutePath`, `rawCode`, `remappings`, `libs`, `fao`, `sync`): `Effect`\<`never`, [`ModuleFactoryError`](../type-aliases/ModuleFactoryError.md), `Map`\<`string`, [`ModuleInfo`](../../types/interfaces/ModuleInfo.md)\>\> -Creates a module from the given module information. -This includes resolving all imports and creating a dependency graph. - -Currently it modifies the source code in place which causes the ast to not match the source code. -This complexity leaks to the typescript lsp which has to account for this -Ideally we refactor this to not need to modify source code in place -Doing this hurts our ability to control the import graph and make it use node resolution though -See foundry that is alergic to using npm -Doing it this way for now is easier but for sure a leaky abstraction - ## Parameters • **absolutePath**: `string` @@ -38,31 +28,6 @@ Whether to run this synchronously or not `Effect`\<`never`, [`ModuleFactoryError`](../type-aliases/ModuleFactoryError.md), `Map`\<`string`, [`ModuleInfo`](../../types/interfaces/ModuleInfo.md)\>\> -## Example - -```ts -const pathToSolidity = path.join(__dirname, '../Contract.sol') -const rawCode = fs.readFileSync(pathToSolidity, 'utf8'), - -const modules = runPromise( - moduleFactory( - pathToSolidity, - rawCode, - { - "remapping": "remapping/src" - }, - ["lib/path"], - { - readFileSync, - readFile, - existsSync, - }, - false - ) -) -console.log(modules.get(pathToSolidity)) // { id: '/path/to/Contract.sol', rawCode: '...', importedIds: ['/path/to/Imported.sol'], code: '...' } -``` - ## Defined in [moduleFactory.js:53](https://github.com/evmts/tevm-monorepo/blob/main/bundler-packages/resolutions/src/moduleFactory.js#L53) diff --git a/bundler-packages/resolutions/docs/resolveImports/functions/resolveImports.md b/bundler-packages/resolutions/docs/resolveImports/functions/resolveImports.md index 0766e4ecee..f95806ea96 100644 --- a/bundler-packages/resolutions/docs/resolveImports/functions/resolveImports.md +++ b/bundler-packages/resolutions/docs/resolveImports/functions/resolveImports.md @@ -8,8 +8,6 @@ > **resolveImports**(`absolutePath`, `code`, `remappings`, `libs`, `sync`): `Effect`\<`never`, [`ResolveImportsError`](../type-aliases/ResolveImportsError.md), readonly [`ResolvedImport`](../../types/type-aliases/ResolvedImport.md)[]\> -Returns a the import resolutions for the given code - ## Parameters • **absolutePath**: `string` @@ -26,26 +24,6 @@ Returns a the import resolutions for the given code `Effect`\<`never`, [`ResolveImportsError`](../type-aliases/ResolveImportsError.md), readonly [`ResolvedImport`](../../types/type-aliases/ResolvedImport.md)[]\> -## Example - -```ts -const pathToSolidity = path.join(__dirname, '../Contract.sol') -const code = fs.readFileSync(pathToSolidity, 'utf8'), -const remappings = {} -const lib = [] - -const imports = runPromise( - resolveImports( - pathToSolidity, - code, - remappings, - libs, - false - ) -) -console.log(imports) // [{ updated: '/path/to/Contract.sol', absolute: '/path/to/Contract.sol', original: '../Contract.sol' }] -``` - ## Defined in [resolveImports.js:50](https://github.com/evmts/tevm-monorepo/blob/main/bundler-packages/resolutions/src/resolveImports.js#L50) diff --git a/bundler-packages/runtime/docs/README.md b/bundler-packages/runtime/docs/README.md index 81d306a709..6eedea2cca 100644 --- a/bundler-packages/runtime/docs/README.md +++ b/bundler-packages/runtime/docs/README.md @@ -26,12 +26,12 @@ # @tevm/runtime -Internal code for generating the runtime contract code for [@tevm/base](../bundler) +Internal code for generating the runtime contract code for [@tevm/base]() -Generated API Docs at [./docs/](./docs) +Generated API Docs at [./docs/]() ## See [Tevm Beta project board](https://github.com/orgs/tevm/projects/1) for progress on the upcoming beta release ## License 📄 - + diff --git a/bundler-packages/runtime/docs/_media/LICENSE b/bundler-packages/runtime/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/bundler-packages/runtime/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -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. diff --git a/bundler-packages/solc/docs/README.md b/bundler-packages/solc/docs/README.md index 725af1c308..1e16f4bd6f 100644 --- a/bundler-packages/solc/docs/README.md +++ b/bundler-packages/solc/docs/README.md @@ -30,4 +30,4 @@ Utils built around solc ## License 📄 - + diff --git a/bundler-packages/solc/docs/_media/LICENSE b/bundler-packages/solc/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/bundler-packages/solc/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -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. diff --git a/bundler-packages/solc/docs/functions/solcCompile.md b/bundler-packages/solc/docs/functions/solcCompile.md index a98564ac42..deefb1bcb3 100644 --- a/bundler-packages/solc/docs/functions/solcCompile.md +++ b/bundler-packages/solc/docs/functions/solcCompile.md @@ -8,8 +8,6 @@ > **solcCompile**(`solc`, `input`): [`SolcOutput`](../type-aliases/SolcOutput.md) -Typesafe wrapper around solc.compile - ## Parameters • **solc**: `any` diff --git a/packages/effect/docs/README.md b/packages/effect/docs/README.md index 5d07b5559c..6879d62085 100644 --- a/packages/effect/docs/README.md +++ b/packages/effect/docs/README.md @@ -36,4 +36,4 @@ Low level tools around [effect.ts](https://www.effect.website/docs/why-effect) ## License 📄 - + diff --git a/packages/effect/docs/_media/LICENSE b/packages/effect/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/effect/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -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. diff --git a/packages/effect/docs/createRequireEffect/classes/CreateRequireError.md b/packages/effect/docs/createRequireEffect/classes/CreateRequireError.md index 8e9498baf9..bf13baddc1 100644 --- a/packages/effect/docs/createRequireEffect/classes/CreateRequireError.md +++ b/packages/effect/docs/createRequireEffect/classes/CreateRequireError.md @@ -110,6 +110,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -120,10 +124,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `Error.prepareStackTrace` diff --git a/packages/effect/docs/createRequireEffect/classes/RequireError.md b/packages/effect/docs/createRequireEffect/classes/RequireError.md index e6bd5fa9ee..60836149eb 100644 --- a/packages/effect/docs/createRequireEffect/classes/RequireError.md +++ b/packages/effect/docs/createRequireEffect/classes/RequireError.md @@ -110,6 +110,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -120,10 +124,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `Error.prepareStackTrace` diff --git a/packages/effect/docs/createRequireEffect/functions/createRequireEffect.md b/packages/effect/docs/createRequireEffect/functions/createRequireEffect.md index c66502a275..29506072ca 100644 --- a/packages/effect/docs/createRequireEffect/functions/createRequireEffect.md +++ b/packages/effect/docs/createRequireEffect/functions/createRequireEffect.md @@ -8,10 +8,6 @@ > **createRequireEffect**(`url`): `Effect`\<`never`, [`CreateRequireError`](../classes/CreateRequireError.md), (`id`) => `Effect`\<`never`, [`RequireError`](../classes/RequireError.md), `any`\>\> -An [Effect](https://www.effect.website/docs/introduction) wrapper around createRequire -createRequire is used to use the node.js `require` function in esm modules and cjs modules -in a way that is compatible with both. It also wraps them weith Effect for better error handling - ## Parameters • **url**: `string` @@ -24,18 +20,6 @@ url to create require from require function -## Example - -```typescript -import { createRequireEffect } from '@eth-optimism/config' -const requireEffect = createRequireEffect(import.meta.url) -const solcEffect = requireEffect('solc') -``` - -## See - -https://nodejs.org/api/modules.html#modules_module_createrequire_filename - ## Defined in [packages/effect/src/createRequireEffect.js:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/effect/src/createRequireEffect.js#L50) diff --git a/packages/effect/docs/fileExists/functions/fileExists.md b/packages/effect/docs/fileExists/functions/fileExists.md index f8ecb21590..b6e9fde507 100644 --- a/packages/effect/docs/fileExists/functions/fileExists.md +++ b/packages/effect/docs/fileExists/functions/fileExists.md @@ -8,8 +8,6 @@ > **fileExists**(`path`): `Effect`\<`never`, `never`, `boolean`\> -Checks if a file exists at the given path - ## Parameters • **path**: `string` @@ -22,13 +20,6 @@ path to check true if the file exists, false otherwise -## Example - -```typescript -import { fileExists } from '@eth-optimism/config' -await fileExists('./someFile.txt') -``` - ## Defined in [packages/effect/src/fileExists.js:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/effect/src/fileExists.js#L16) diff --git a/packages/effect/docs/logAllErrors/functions/logAllErrors.md b/packages/effect/docs/logAllErrors/functions/logAllErrors.md index 7f08913925..2e4d8efbd0 100644 --- a/packages/effect/docs/logAllErrors/functions/logAllErrors.md +++ b/packages/effect/docs/logAllErrors/functions/logAllErrors.md @@ -8,8 +8,6 @@ > **logAllErrors**(`e`): `Effect`\<`never`, `never`, `void`\> -Logs all errors and causes from effect - ## Parameters • **e**: `unknown` @@ -18,15 +16,6 @@ Logs all errors and causes from effect `Effect`\<`never`, `never`, `void`\> -## Example - -```typescript -import { logAllErrors } from '@eth-optimism/config' - -someEffect.pipe( - tapError(logAllErrors) -) - ## Defined in [packages/effect/src/logAllErrors.js:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/effect/src/logAllErrors.js#L16) diff --git a/packages/effect/docs/parseJson/classes/ParseJsonError.md b/packages/effect/docs/parseJson/classes/ParseJsonError.md index adedca9ce5..d45a62a6a2 100644 --- a/packages/effect/docs/parseJson/classes/ParseJsonError.md +++ b/packages/effect/docs/parseJson/classes/ParseJsonError.md @@ -112,6 +112,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -122,10 +126,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `Error.prepareStackTrace` diff --git a/packages/effect/docs/parseJson/functions/parseJson.md b/packages/effect/docs/parseJson/functions/parseJson.md index 98a2a46851..d301c517f3 100644 --- a/packages/effect/docs/parseJson/functions/parseJson.md +++ b/packages/effect/docs/parseJson/functions/parseJson.md @@ -8,8 +8,6 @@ > **parseJson**(`jsonStr`): `Effect`\<`never`, [`ParseJsonError`](../classes/ParseJsonError.md), `unknown`\> -Parses a json string - ## Parameters • **jsonStr**: `string` @@ -18,17 +16,6 @@ Parses a json string `Effect`\<`never`, [`ParseJsonError`](../classes/ParseJsonError.md), `unknown`\> -## Throws - -when the tevm.json file is not valid json - -## Example - -```ts -const jsonEffect = parseJson('{ "compilerOptions": { "plugins": [{ "name": "@tevm/ts-plugin" }] } }') -```` -@internal - ## Defined in [packages/effect/src/parseJson.js:33](https://github.com/evmts/tevm-monorepo/blob/main/packages/effect/src/parseJson.js#L33) diff --git a/packages/effect/docs/resolve/classes/CouldNotResolveImportError.md b/packages/effect/docs/resolve/classes/CouldNotResolveImportError.md index 48747530a3..1ba5681f9f 100644 --- a/packages/effect/docs/resolve/classes/CouldNotResolveImportError.md +++ b/packages/effect/docs/resolve/classes/CouldNotResolveImportError.md @@ -112,6 +112,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -122,10 +126,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `Error.prepareStackTrace` diff --git a/packages/effect/docs/resolve/functions/resolveAsync.md b/packages/effect/docs/resolve/functions/resolveAsync.md index 8e415d713a..a1df74a636 100644 --- a/packages/effect/docs/resolve/functions/resolveAsync.md +++ b/packages/effect/docs/resolve/functions/resolveAsync.md @@ -20,16 +20,6 @@ Effect wrpper around import('node:resolve') `Effect`\<`never`, [`CouldNotResolveImportError`](../classes/CouldNotResolveImportError.md), `string`\> -## Example - -```ts -import {tap} from 'effect/Effect' -import {resolveAsync} from '@tevm/effect' -resolveAsync('react').pipe( - tap(console.log) -) -```` - ## Defined in [packages/effect/src/resolve.js:65](https://github.com/evmts/tevm-monorepo/blob/main/packages/effect/src/resolve.js#L65) diff --git a/packages/effect/docs/resolve/functions/resolveSync.md b/packages/effect/docs/resolve/functions/resolveSync.md index 4d26f2e64e..a2a4c45d03 100644 --- a/packages/effect/docs/resolve/functions/resolveSync.md +++ b/packages/effect/docs/resolve/functions/resolveSync.md @@ -20,17 +20,6 @@ Effect wrapper around import('node:resolve').resolveSync `Effect`\<`never`, [`CouldNotResolveImportError`](../classes/CouldNotResolveImportError.md), `string`\> -## Example - -```ts -import {tap} from 'effect/Effect' -import {resolveSync} from '@tevm/effect' -resolveSync('react').pipe( - tap(console.log) -) -```` -` - ## Defined in [packages/effect/src/resolve.js:46](https://github.com/evmts/tevm-monorepo/blob/main/packages/effect/src/resolve.js#L46)