Handle 'true'/'false' stringified boolean options and better config error handling #520

gitKrystan · 2023-03-02T22:18:55Z

Coerce 'true'/'false' into actual booleans (Fixes Passing boolean flag options not working correctly #223)
Better error messages

Ideally, we'd use yargs for this, but doing so would involve changing codemod-cli to allow consumers to pass in yargs options here:

https://github.com/rwjblue/codemod-cli/blob/4a126ec9cd0ff4a482a69aa7f872ec629e23ba66/src/options-support.js#L14

Coerce 'true'/'false' into actual booleans (Fixes ember-codemods#223) Better error messages

gitKrystan · 2023-03-02T22:31:45Z

transforms/ember-object/index.ts

@@ -20,7 +20,7 @@ const transformer: Transform = function (

  if (replaced) {
    source = root.toSource({
-      quote: userOptions.quotes ?? userOptions.quote,


quotes was never documented and was redundant with quote, so I removed it.

wycats

Looks good! I have a few (non-blocking) questions, mostly because I'm new to zod.

wycats · 2023-03-07T16:27:26Z

test/options.test.ts

@@ -0,0 +1,254 @@
+import { describe, expect, test } from '@jest/globals';


I'm loving all these new tests. Great job!

wycats · 2023-03-07T16:30:06Z

transforms/helpers/options.ts

-      return typeof arg === 'string' ? arg.split(/\s*,\s*/) : arg;
-    }, z.array(z.string())),
+    inObjectLiterals: StringArraySchema.describe(
+      'Allow-list for decorators currently applied to object literal properties that can be safely applied to class properties.'


I find this message pretty confusing. What exactly is it trying to say?

Input:

ember-native-class-codemod/transforms/ember-object/__testfixtures__/options/object-literal-decorators.input.js

Lines 3 to 6 in f8d8fd2

const Foo = EmberObject.extend({

@userAdded

whatever: undefined

});

Config:

ember-native-class-codemod/transforms/ember-object/__testfixtures__/options/object-literal-decorators.options.json

Lines 1 to 5 in f8d8fd2

{

"decorators": {

"inObjectLiterals": ["userAdded"]

}

}

Output:

ember-native-class-codemod/transforms/ember-object/__testfixtures__/options/object-literal-decorators.output.js

Lines 4 to 8 in f8d8fd2

@classic

class Foo extends EmberObject {

@userAdded

whatever;

}

Without the config, the @userAdded decorator would not transform at all because it's applied to a property and not a method.

What about something like:

A list of decorators that are allowed in object literals. When the codemod finds a field with one of these decorators, it will be translated directly into a class field with the same decorator. Including a decorator in this list means that you believe that the decorator will work correctly on a class field.

transforms/helpers/options.ts

wycats · 2023-03-07T16:33:26Z

transforms/helpers/options.ts

@@ -1,49 +1,98 @@
+import { inspect } from 'node:util';
 import type { ZodError } from 'zod';


TIL zod. What do you think about ts-to-zod?

I haven't tried ts-to-zod, but zod is already based on TS APIs and terminology, so it's super intuitive (to me) as-is.

wycats · 2023-03-07T16:34:01Z

transforms/helpers/schema-helper.ts

+import type { ZodEffects, ZodTypeAny } from 'zod';
+import { z } from 'zod';
+
+const preprocessStringToBoolean = <I extends ZodTypeAny>(


This file seems like a good place to DRY up some of the union error message duplication.

Based on your previous answer, it seems like you considered this but it wasn't worth it. Right?

Correct. I tried it but didn't like the built-in error messages.

gitKrystan force-pushed the better-args branch 2 times, most recently from 8a1acfd to 8949b37 Compare March 2, 2023 22:20

Clean up options schemas

0ceac37

Coerce 'true'/'false' into actual booleans (Fixes ember-codemods#223) Better error messages

gitKrystan force-pushed the better-args branch from 8949b37 to 0ceac37 Compare March 2, 2023 22:30

gitKrystan commented Mar 2, 2023

View reviewed changes

gitKrystan requested a review from wycats March 2, 2023 22:35

gitKrystan added bug Something isn't working enhancement New feature or request labels Mar 2, 2023

gitKrystan changed the title ~~Clean up user options schemas~~ Handle 'true'/'false' stringified boolean options and better config error handling Mar 2, 2023

wycats reviewed Mar 7, 2023

View reviewed changes

gitKrystan force-pushed the better-args branch from 46d67ea to 38bd901 Compare March 7, 2023 18:47

Update inObjectLiterals config documentation

cdb8b11

gitKrystan force-pushed the better-args branch from 38bd901 to cdb8b11 Compare March 7, 2023 18:56

gitKrystan merged commit 38d9da2 into ember-codemods:master Mar 7, 2023

gitKrystan deleted the better-args branch March 7, 2023 19:04

gitKrystan removed the enhancement New feature or request label Mar 9, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Handle 'true'/'false' stringified boolean options and better config error handling #520

Handle 'true'/'false' stringified boolean options and better config error handling #520

Uh oh!

gitKrystan commented Mar 2, 2023 •

edited

Loading

Uh oh!

gitKrystan Mar 2, 2023

Uh oh!

wycats left a comment

Uh oh!

wycats Mar 7, 2023

Uh oh!

wycats Mar 7, 2023

Uh oh!

gitKrystan Mar 7, 2023

Uh oh!

wycats Mar 7, 2023 •

edited

Loading

Uh oh!

Uh oh!

wycats Mar 7, 2023

Uh oh!

gitKrystan Mar 7, 2023 •

edited

Loading

Uh oh!

wycats Mar 7, 2023

Uh oh!

wycats Mar 7, 2023 •

edited

Loading

Uh oh!

gitKrystan Mar 7, 2023

Uh oh!

Uh oh!

		@@ -0,0 +1,254 @@
		import { describe, expect, test } from '@jest/globals';

	const Foo = EmberObject.extend({
	@userAdded
	whatever: undefined
	});

		@@ -1,49 +1,98 @@
		import { inspect } from 'node:util';
		import type { ZodError } from 'zod';

Handle 'true'/'false' stringified boolean options and better config error handling #520

Handle 'true'/'false' stringified boolean options and better config error handling #520

Uh oh!

Conversation

gitKrystan commented Mar 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gitKrystan Mar 2, 2023

Choose a reason for hiding this comment

Uh oh!

wycats left a comment

Choose a reason for hiding this comment

Uh oh!

wycats Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

wycats Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

gitKrystan Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

wycats Mar 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

wycats Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

gitKrystan Mar 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wycats Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

wycats Mar 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gitKrystan Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gitKrystan commented Mar 2, 2023 •

edited

Loading

wycats Mar 7, 2023 •

edited

Loading

gitKrystan Mar 7, 2023 •

edited

Loading

wycats Mar 7, 2023 •

edited

Loading