Skip to content

Commit

Permalink
feat: remove carpentry condition
Browse files Browse the repository at this point in the history
  • Loading branch information
ianwremmel committed Jun 10, 2024
1 parent 932c365 commit 38e557a
Show file tree
Hide file tree
Showing 26 changed files with 2 additions and 75 deletions.
1 change: 0 additions & 1 deletion .env

This file was deleted.

23 changes: 0 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
- [Contribute](#contribute)
- [nx](#nx)
- [`@clc` vs `@code-like-a-carpenter`](#clc-vs-code-like-a-carpenter)
- [Local development without building first](#local-development-without-building-first)
- [License](#license)

<!-- tocstop -->
Expand Down Expand Up @@ -92,28 +91,6 @@ only does this plugin need to a different package.json layout (it's `main` entry
needs to point to a typescript file, not a built file), it just wouldn't make
sense outside the context of this particular repository.

### Local development without building first

In addition to `cjs`/`esm` entries in each package's export map, there's also a
`carpentry` entry which exports the typescript source code. By setting
`NODE_OPTIONS='--conditions=carpentry`, `nx` _should_ be able to use project
code without building it first.

If you're debugging a cli, you can also `--import tsx` during development to run
without building everything first:

```sh
NODE_OPTIONS='--conditions=carpentry --import tsx' npx @code-like-a-carpenter/cli
```

This approach isn't fully compatible with `nx` yet. By setting `--import tsx`,
`nx` ends up with libraries vying to import typescript files and errors. Since
`--import` cannot be set on the environment when using `nx`, `nx` cannot call
local clis that need to be transpiled on the fly. Either they need to be build
before they get invoked as an `nx` target or (prefferably), they would also
export an `nx` executor that can be called directly. If we don't need to shell
out to a subprocess, we can rely on `nx`'s automatically registered swc/node

## License

MIT &copy; [Ian Remmel](https://github.com/ianwremmel) 2019 until at least now
2 changes: 0 additions & 2 deletions packages/@clc/nx/executors/package-json/executor.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,13 @@ async function config(pkg, mjs, mts, type, context) {
import: {
types:
mjs || mts ? './dist/types/index.d.mts' : './dist/types/index.d.ts',
...(mjs ? {} : {carpentry: mts ? './src/index.mts' : './src/index.ts'}),
default: mjs ? './src/index.mjs' : './dist/esm/index.mjs',
},
require: {
types:
mjs || mts
? './dist/cjs-types/index.d.ts'
: './dist/types/index.d.ts',
...(mjs ? {} : {carpentry: mts ? './src/index.mts' : './src/index.ts'}),
default: './dist/cjs/index.cjs',
},
/* eslint-enable sort-keys */
Expand Down
7 changes: 2 additions & 5 deletions packages/@clc/nx/src/helpers.mjs
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import assert from 'node:assert';

import {writePrettierFile} from '@code-like-a-carpenter/tooling-common';

/** @typedef {import('@nx/devkit').ExecutorContext} ExecutorContext */

/** @typedef {import('@schemastore/package')} JSONSchemaForNPMPackageJsonFiles */
Expand Down Expand Up @@ -31,10 +33,5 @@ export function extractProjectRoot(context) {
* @param {JSONSchemaForNPMPackageJsonFiles} pkg
*/
export async function writePackageJson(filename, pkg) {
// This needs to be late-imported because nx doesn't do its dotenv loading
// early enough, so --conditions=carpentry isn't yet set.
const {writePrettierFile} = await import(
'@code-like-a-carpenter/tooling-common'
);
await writePrettierFile(filename, JSON.stringify(pkg, null, 2));
}
2 changes: 0 additions & 2 deletions packages/@code-like-a-carpenter/aws-env-loader/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
2 changes: 0 additions & 2 deletions packages/@code-like-a-carpenter/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
2 changes: 0 additions & 2 deletions packages/@code-like-a-carpenter/contract-tests/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
2 changes: 0 additions & 2 deletions packages/@code-like-a-carpenter/dotenv/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
2 changes: 0 additions & 2 deletions packages/@code-like-a-carpenter/errors/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
2 changes: 0 additions & 2 deletions packages/@code-like-a-carpenter/exception/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
2 changes: 0 additions & 2 deletions packages/@code-like-a-carpenter/interact/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
2 changes: 0 additions & 2 deletions packages/@code-like-a-carpenter/lambda-handlers/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
2 changes: 0 additions & 2 deletions packages/@code-like-a-carpenter/logger/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
2 changes: 0 additions & 2 deletions packages/@code-like-a-carpenter/parallel/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
2 changes: 0 additions & 2 deletions packages/@code-like-a-carpenter/sentry/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
2 changes: 0 additions & 2 deletions packages/@code-like-a-carpenter/telemetry/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
2 changes: 0 additions & 2 deletions packages/@code-like-a-carpenter/tool-foundation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down
2 changes: 0 additions & 2 deletions packages/@code-like-a-carpenter/wait-for/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@
".": {
"import": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/types/index.d.ts",
"carpentry": "./src/index.ts",
"default": "./dist/cjs/index.cjs"
}
},
Expand Down

0 comments on commit 38e557a

Please sign in to comment.