♻️ chore: Move general utils out of config package (#600)

Move general utils out of config package to effect package

Explain the quality checks that have been done on the code changes

- [ ] I read the [contributing docs](../docs/contributing.md) (if this
is your first contribution)

Your ENS/address:

Co-authored-by: Will Cory <[email protected]>

config/README.md

@@ -30,7 +30,7 @@ Tools for configuring `evmts.config.ts` file.
 
 ## See [Evmts Beta project board](https://github.com/orgs/evmts/projects/1) for progress on the upcoming beta release
 
-## See [Contributing docs](./CONTRIBUTING.md) for detailed contributing docs
+## See [Contributing docs](https://github.com/evmts/evmts-monorepo/blob/main/config/CONTRIBUTING.md) for detailed contributing docs
 
 ## License 📄
 

config/package.json

@@ -60,6 +60,7 @@
   },
   "dependencies": {
     "@effect/schema": "^0.45.5",
+    "@evmts/effect": "workspace:^",
     "@types/node": "^20.7.2",
     "bundle-require": "^4.0.2",
     "effect": "^2.0.0-next.50",

config/scripts/runFixture.ts

@@ -63,7 +63,7 @@ export const runFixture = (name: string) => {
 	runSync(
 		provide(
 			loadConfig(configDir).pipe(
-				flatMap(config => {
+				flatMap((config) => {
 					if (expectedErrors.includes(validName)) {
 						return fail(config)
 					}
@@ -74,9 +74,10 @@ export const runFixture = (name: string) => {
 						return succeed(e)
 					}
 					return logError(
-						`error running ${validName} ${expectedErrors.includes(validName)
-							? `should have errored but didn't`
-							: 'error'
+						`error running ${validName} ${
+							expectedErrors.includes(validName)
+								? `should have errored but didn't`
+								: 'error'
 						}. Try running the individual fixture with "bun fixture ${validName}"`,
 					).pipe(flatMap(() => fail(e)))
 				}),

config/src/config/index.js

@@ -0,0 +1,3 @@
+export * from './mergeConfigs.js'
+export * from './validateUserConfig.js'
+export * from './withDefaults.js'

config/src/defineConfig.js

@@ -1,7 +1,9 @@
-import { loadFoundryConfig } from './utils/loadFoundryConfig.js'
-import { mergeConfigs } from './utils/mergeConfigs.js'
-import { validateUserConfig } from './utils/validateUserConfig.js'
-import { withDefaults } from './utils/withDefaults.js'
+import {
+	mergeConfigs,
+	validateUserConfig,
+	withDefaults,
+} from './config/index.js'
+import { loadFoundryConfig } from './foundry/index.js'
 import { all, catchTags, fail, flatMap, logDebug, tap } from 'effect/Effect'
 
 /**

config/src/foundry/index.js

@@ -0,0 +1 @@
+export * from './loadFoundryConfig.js'

config/src/utils/loadFoundryConfig.js → config/src/foundry/loadFoundryConfig.js

@@ -1,3 +1,4 @@
+// TODO would be nice to break this up into composable effects
 import { execSync } from 'child_process'
 import { fail, logDebug, succeed, tap } from 'effect/Effect'
 import * as path from 'path'

config/src/index.js

@@ -3,6 +3,6 @@
  * @typedef {import('./types.js').ResolvedCompilerConfig} ResolvedCompilerConfig
  */
 
-export { defaultConfig } from './utils/withDefaults.js'
+export { defaultConfig } from './config/index.js'
 export { defineConfig } from './defineConfig.js'
 export { loadConfig } from './loadConfig.js'

config/src/loadConfig.js

@@ -1,9 +1,7 @@
-import { getEvmtsConfigFromTsConfig } from './utils/getEvmtsConfigFromTsConfig.js'
-import { loadFoundryConfig } from './utils/loadFoundryConfig.js'
-import { loadTsConfig } from './utils/loadTsConfig.js'
-import { logAllErrors } from './utils/logAllErrors.js'
-import { mergeConfigs } from './utils/mergeConfigs.js'
-import { withDefaults } from './utils/withDefaults.js'
+import { mergeConfigs, withDefaults } from './config/index.js'
+import { loadFoundryConfig } from './foundry/index.js'
+import { getEvmtsConfigFromTsConfig, loadTsConfig } from './tsconfig/index.js'
+import { logAllErrors } from '@evmts/effect'
 import {
 	all,
 	catchTags,
@@ -15,7 +13,7 @@ import {
 } from 'effect/Effect'
 
 /**
- * @typedef {import("./utils/loadTsConfig.js").LoadTsConfigError | import("./utils/getEvmtsConfigFromTsConfig.js").GetEvmtsConfigFromTsConfigError | import("./utils/loadFoundryConfig.js").LoadFoundryConfigError} LoadConfigErrorType
+ * @typedef {import("./tsconfig/index.js").LoadTsConfigError | import("./tsconfig/index.js").GetEvmtsConfigFromTsConfigError | import("./foundry/index.js").LoadFoundryConfigError} LoadConfigErrorType
  */
 
 /**

config/src/utils/getEvmtsConfigFromTsConfig.js → config/src/tsconfig/getEvmtsConfigFromTsConfig.js

@@ -1,4 +1,4 @@
-import { validateUserConfig } from './validateUserConfig.js'
+import { validateUserConfig } from '../config/index.js'
 import { fail, logDebug, map, tap } from 'effect/Effect'
 
 /**
@@ -13,7 +13,7 @@ export class NoPluginFoundError extends Error {
 }
 
 /**
- * @typedef {NoPluginFoundError | import("./validateUserConfig.js").ValidateUserConfigError } GetEvmtsConfigFromTsConfigError
+ * @typedef {NoPluginFoundError | import("../config/index.js").ValidateUserConfigError } GetEvmtsConfigFromTsConfigError
  */
 
 /**

config/src/tsconfig/index.js

@@ -0,0 +1,2 @@
+export * from './getEvmtsConfigFromTsConfig.js'
+export * from './loadTsConfig.js'

config/src/utils/loadTsConfig.js → config/src/tsconfig/loadTsConfig.js

@@ -1,11 +1,11 @@
-import { parseJson } from './parseJson.js'
 import {
 	array,
 	optional,
 	parseEither,
 	string,
 	struct,
 } from '@effect/schema/Schema'
+import { parseJson } from '@evmts/effect'
 import { Effect } from 'effect'
 import { catchTag, fail, flatMap, logDebug, tap } from 'effect/Effect'
 import { existsSync, readFileSync } from 'fs'
@@ -66,7 +66,7 @@ const STsConfig = struct({
 })
 
 /**
- * @typedef {import("./parseJson.js").ParseJsonError | FailedToReadConfigError | InvalidTsConfigError} LoadTsConfigError
+ * @typedef {import("@evmts/effect").ParseJsonError | FailedToReadConfigError | InvalidTsConfigError} LoadTsConfigError
  * @internal
  */
 

config/src/utils/loadTsConfig.spec.ts → config/src/tsconfig/loadTsConfig.spec.ts

@@ -5,7 +5,7 @@ import {
 	InvalidTsConfigError,
 	loadTsConfig,
 } from './loadTsConfig.js'
-import { ParseJsonError } from './parseJson.js'
+import { ParseJsonError } from '@evmts/effect'
 import { runSync } from 'effect/Effect'
 import { join } from 'path'
 

config/src/types.ts

@@ -1,6 +1,6 @@
+import type { ValidateUserConfigError } from './config/index.js'
 import type { DefineConfigError } from './defineConfig.js'
-import type { LoadFoundryConfigError } from './utils/loadFoundryConfig.js'
-import type { ValidateUserConfigError } from './utils/validateUserConfig.js'
+import type { LoadFoundryConfigError } from './foundry/index.js'
 import type { Effect } from 'effect/Effect'
 import type { ReadonlyRecord } from 'effect/ReadonlyRecord'
 

config/vitest.config.ts

@@ -7,10 +7,10 @@ export default defineConfig({
 		environment: 'node',
 		coverage: {
 			reporter: ['text', 'json-summary', 'json'],
-			lines: 98.83,
-			statements: 98.83,
+			lines: 98.54,
+			statements: 98.54,
 			functions: 100,
-			branches: 99.12,
+			branches: 98.83,
 			thresholdAutoUpdate: true,
 		},
 	},

docs/reference/config/README.md

@@ -32,7 +32,7 @@ Tools for configuring `evmts.config.ts` file.
 
 ## See [Evmts Beta project board](https://github.com/orgs/evmts/projects/1) for progress on the upcoming beta release
 
-## See [Contributing docs](./CONTRIBUTING.md) for detailed contributing docs
+## See [Contributing docs](https://github.com/evmts/evmts-monorepo/blob/main/config/CONTRIBUTING.md) for detailed contributing docs
 
 ## License 📄
 

docs/reference/config/modules.md

@@ -78,7 +78,7 @@ The default CompilerConfig
 
 #### Defined in
 
-[utils/withDefaults.js:6](https://github.com/evmts/evmts-monorepo/blob/main/config/src/utils/withDefaults.js#L6)
+[config/withDefaults.js:6](https://github.com/evmts/evmts-monorepo/blob/main/config/src/config/withDefaults.js#L6)
 
 ## Functions
 
@@ -149,4 +149,4 @@ runPromise(loadConfig('./tsconfig.json')).pipe(
 
 #### Defined in
 
-[loadConfig.js:63](https://github.com/evmts/evmts-monorepo/blob/main/config/src/loadConfig.js#L63)
+[loadConfig.js:61](https://github.com/evmts/evmts-monorepo/blob/main/config/src/loadConfig.js#L61)

docs/reference/effect/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/reference/effect/README.md

@@ -0,0 +1,37 @@
+@evmts/effect / [Exports](/reference/effect/modules.md)
+
+<p align="center">
+  <a href="https://evmts.dev/">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/35039927/218812217-92f0f784-cb85-43b9-9ca6-e2b9effd9eb2.png">
+      <img alt="wagmi logo" src="https://user-images.githubusercontent.com/35039927/218812217-92f0f784-cb85-43b9-9ca6-e2b9effd9eb2.png" width="auto" height="300">
+    </picture>
+  </a>
+</p>
+
+<p align="center">
+  Execute solidity scripts in browser
+</p>
+
+[![CI](https://github.com/evmts/evmts-monorepo/actions/workflows/e2e.yml/badge.svg)](https://github.com/evmts/evmts-monorepo/actions/workflows/e2e.yml)
+[![CI](https://github.com/evmts/evmts-monorepo/actions/workflows/unit.yml/badge.svg)](https://github.com/evmts/evmts-monorepo/actions/workflows/unit.yml)
+<a href="https://www.npmjs.com/package/@evmts/core" target="\_parent">
+<img alt="" src="https://img.shields.io/npm/dm/@evmts/core.svg" />
+</a>
+<a href="https://bundlephobia.com/package/@evmts/core@latest" target="\_parent">
+<img alt="" src="https://badgen.net/bundlephobia/minzip/@evmts/core" />
+</a>
+
+# @evmts/effect
+
+Low level tools around [effect.ts](https://www.effect.website/docs/why-effect)
+
+## Visit [Docs](https://evmts.dev/) for docs, guides, API and more!
+
+## See [Evmts Beta project board](https://github.com/orgs/evmts/projects/1) for progress on the upcoming beta release
+
+## See [Contributing docs](https://github.com/evmts/evmts-monorepo/blob/main/effect/CONTRIBUTING.md) for detailed contributing docs
+
+## License 📄
+
+<a href="./LICENSE"><img src="https://user-images.githubusercontent.com/35039927/231030761-66f5ce58-a4e9-4695-b1fe-255b1bceac92.png" width="200" /></a>