@ember-data/codemods package

.vscode/launch.json

@@ -0,0 +1,52 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "bun",
+      "request": "launch",
+      "name": "Debug Bun",
+
+      // The path to a JavaScript or TypeScript file to run.
+      "program": "${file}",
+
+      // The arguments to pass to the program, if any.
+      "args": [],
+
+      // The working directory of the program.
+      "cwd": "${workspaceFolder}",
+
+      // The environment variables to pass to the program.
+      "env": {},
+
+      // If the environment variables should not be inherited from the parent process.
+      "strictEnv": false,
+
+      // If the program should be run in watch mode.
+      // This is equivalent to passing `--watch` to the `bun` executable.
+      // You can also set this to "hot" to enable hot reloading using `--hot`.
+      "watchMode": false,
+
+      // If the debugger should stop on the first line of the program.
+      "stopOnEntry": false,
+
+      // If the debugger should be disabled. (for example, breakpoints will not be hit)
+      "noDebug": false,
+
+      // The path to the `bun` executable, defaults to your `PATH` environment variable.
+      "runtime": "bun",
+
+      // The arguments to pass to the `bun` executable, if any.
+      // Unlike `args`, these are passed to the executable itself, not the program.
+      "runtimeArgs": []
+    },
+    {
+      "type": "bun",
+      "request": "attach",
+      "name": "Attach to Bun",
+
+      // The URL of the WebSocket inspector to attach to.
+      // This value can be retrieved by using `bun --inspect`.
+      "url": "ws://localhost:6499/"
+    }
+  ]
+}

.vscode/settings.json

@@ -39,5 +39,6 @@
     "editor.insertSpaces": false,
     "editor.tabSize": 4
   },
-  "typescript.preferences.importModuleSpecifier": "project-relative"
+  "typescript.preferences.importModuleSpecifier": "project-relative",
+  "bun.debugTerminal.enabled": true
 }

config/eslint/ignore.cjs

@@ -24,6 +24,7 @@ const RULES = [
   'node_modules',
   '.node_modules.ember-try',
   'package.json.ember-try',
+  'tests/__testfixtures__',
 ];
 
 function ignoreRules(allowAddon) {

packages/codemods/.eslintrc.cjs

@@ -0,0 +1,28 @@
+const base = require('@warp-drive/internal-config/eslint/base.cjs');
+const ignore = require('@warp-drive/internal-config/eslint/ignore.cjs');
+const imports = require('@warp-drive/internal-config/eslint/imports.cjs');
+const isolation = require('@warp-drive/internal-config/eslint/isolation.cjs');
+const node = require('@warp-drive/internal-config/eslint/node.cjs');
+const parser = require('@warp-drive/internal-config/eslint/parser.cjs');
+const typescript = require('@warp-drive/internal-config/eslint/typescript.cjs');
+
+module.exports = {
+  ...parser.defaults(),
+  ...base.settings(),
+
+  plugins: [...base.plugins(), ...imports.plugins()],
+  extends: [...base.extend()],
+  rules: Object.assign(base.rules(), imports.rules(), isolation.rules(), {}),
+
+  ignorePatterns: ignore.ignoreRules(),
+
+  overrides: [
+    node.config(),
+    node.defaults({
+      files: ['src/**', 'bin/**'],
+    }),
+    typescript.defaults({
+      rules: { '@typescript-eslint/switch-exhaustiveness-check': 'error' },
+    }),
+  ],
+};

packages/codemods/README.md

@@ -0,0 +1,135 @@
+# @ember-data/codemods
+
+Codemods for EmberData paradigms.
+
+## Usage
+
+### List all available codemod commands
+
+```
+npx @ember-data/codemods apply --help
+```
+
+The available codemods will be listed under the "Commands" heading.
+
+### Run a codemod
+
+```
+npx @ember-data/codemods apply <codemod-name> [codemod-options] <target-glob-pattern...>
+```
+
+For example:
+
+```
+npx @ember-data/codemods apply legacy-compat-builders ./app/**/*.{js,ts}
+```
+
+#### Codemod options
+
+To list the available options for a particular codemod, you can run:
+
+```
+npx @ember-data/codemods apply <codemod-name> --help
+```
+
+## Codemods
+
+### legacy-compat-builders
+
+```
+npx @ember-data/codemods apply legacy-compat-builders --help
+Usage: @ember-data/codemods apply legacy-compat-builders [options] <target-glob-pattern...>
+
+Updates legacy store methods to use `store.request` and `@ember-data/legacy-compat/builders` instead.
+
+Arguments:
+  target-glob-pattern                    Path to files or glob pattern. If using glob pattern, wrap in single
+                                         quotes.
+
+Options:
+  -d, --dry                              dry run (no changes are made to files) (default: false)
+  -v, --verbose <level>                  Show more information about the transform process (choices: "0", "1",
+                                         "2", default: "0")
+  -l, --log-file [path]                  Write logs to a file. If option is set but no path is provided, logs are
+                                         written to ember-data-codemods.log
+  -i, --ignore <ignore-glob-pattern...>  Ignores the given file or glob pattern. If using glob pattern, wrap in
+                                         single quotes.
+  --store-names <store-name...>          Identifier name associated with the store. If overriding, it is
+                                         recommended that you include 'store' in your list. (default: ["store"])
+  --method, --methods <method-name...>   Method name(s) to transform. By default, will transform all methods.
+                                         (choices: "findAll", "findRecord", "query", "queryRecord", "saveRecord")
+  -h, --help                             display help for command
+```
+
+### Examples
+
+#### `findAll`
+
+```ts
+// before
+const posts = await store.findAll<Post>('post');
+
+// after
+import { findAll } from '@ember-data/legacy-compat/builders';
+const { content: posts } = await store.request<Post[]>(findAll<Post>('post'));
+```
+
+#### `findRecord`
+
+```ts
+// before
+const post = await store.findRecord<Post>({ type: 'post', id: '1' });
+
+// after
+import { findRecord } from '@ember-data/legacy-compat/builders';
+const { content: post } = await store.request<Post>(findRecord<Post>({ type: 'post', id: '1' }));
+```
+
+NOTE: This codemod will not transform `store.findRecord` calls with a 'preload' option set. This option is not supported by the legacy compat builders.
+
+#### `query`
+
+```ts
+// before
+const posts = await store.query<Post>('post', { id: '1' });
+
+// after
+import { query } from '@ember-data/legacy-compat/builders';
+const { content: posts } = await store.request<Post[]>(query<Post>('post', { id: '1' }));
+```
+
+#### `queryRecord`
+
+```ts
+// before
+const post = await store.queryRecord<Post>('post', { id: '1' });
+
+// after
+import { queryRecord } from '@ember-data/legacy-compat/builders';
+const { content: post } = await store.request<Post>(queryRecord<Post>('post', { id: '1' }));
+```
+
+#### `saveRecord`
+
+```ts
+// before
+const post = store.createRecord<Post>('post', { name: 'Krystan rules, you drool' });
+const savedPostWithGeneric = await store.saveRecord<Post>(post);
+const savedPostNoGeneric = await store.saveRecord(post);
+
+// after
+import { saveRecord } from '@ember-data/legacy-compat/builders';
+const post = store.createRecord<Post>('post', { name: 'Krystan rules, you drool' });
+const { content: savedPostWithGeneric } = await store.request<Post>(saveRecord(post));
+const { content: savedPostNoGeneric } = await store.request(saveRecord(post));
+```
+
+### Handling of `await`
+
+Calls to legacy store methods that are not currently awaited will not be transformed. In order to provide feature parity with the legacy method, we need to access the `content` property from `Future` returned by `store.request`. In order to do this, we need to `await store.request`, but we can't safely add `await` with a codemod as we don't know if the consuming code will be able to handle the change.
+
+There is one exception to this rule. In the case where a route's `model` hook returns a call to a legacy store method, the codemod will transform the legacy store method and will add the `await` keyword.
+
+## Caveats
+
+GJS and GTS files are not currently supported. PRs welcome! 🧡