Rewrite in TypeScript #252

tommy-mitchell · 2024-01-28T17:07:13Z

Per #233.

Augmented the types from minimist-options to support the arguments option (see minimist-options.d.ts)
- I wanted to upstream these changes, but I ran into Need way to express hybrid types that are indexable for a subset of properties microsoft/TypeScript#17867 (SO thread)
- Not sure why it's working here but not when I make the changes to minimist-options itself
Related, I kept running into that issue with other types as well, such as the -- option in flags

readme.md

source/index.ts

source/options.ts

tommy-mitchell · 2024-01-28T17:26:12Z

test/test.ts

+			'--': true as unknown as {type: 'string'; isMultiple: true},
+			// TODO: can not model due to microsoft/TypeScript#17867
+			// A potential workaround is to use a symbol for '--' -> {flags: [argvDashDash]: true}


One of the "rest index type" issues

Use a proper URL over microsoft/TypeScript#17867

test/test.ts

tommy-mitchell · 2024-01-28T17:28:32Z

May have missed some comments, but that's the bulk of where I'm needing clarification. The other TODOs I have are reminders to fix type issues.

sindresorhus · 2024-02-06T09:53:57Z

FYI: e9a55cd

tommy-mitchell · 2024-02-27T02:44:27Z

Do we support a shorthand for setting flags?

const cli = meow({
	importMeta: import.meta
	flags: {
		rainbow: 'boolean',
		unicorn: 'string',
	},
});

sindresorhus · 2024-02-27T05:27:17Z

Do we support a shorthand for setting flags?

No. That's not something I want to support either.

tommy-mitchell · 2024-02-27T10:20:17Z

Got it. I think this test case (and maybe another?) had confused me before and I was remembering something about it:

meow/test/errors.js

Lines 38 to 40 in c97c031

    
           test('flag declared in kebab-case is an error', meowThrows, { 
        
           	flags: {'kebab-case': 'boolean', test: 'boolean', 'another-one': 'boolean'}, 
        
           }, {message: 'Flag keys may not contain \'-\'. Invalid flags: `kebab-case`, `another-one`'});

sindresorhus · 2024-02-27T14:00:55Z

That test case is incorrect.

tommy-mitchell · 2024-03-03T17:26:01Z

Updated to reflect changes from other PRs. Type tests are failing due to tsd not seeing minimist-options.d.ts.

source/options.ts

tommy-mitchell · 2024-03-04T18:51:00Z

CI is failing due to sindresorhus/type-fest#824

tommy-mitchell · 2024-03-05T02:43:43Z

I'm not sure how to fix the timeout issue, I get it sometimes locally when running npm test but never with npx ava.

sindresorhus · 2024-03-05T06:13:42Z

Maybe try downgrading to ava@5 for now.

tommy-mitchell · 2024-03-05T18:44:09Z

Didn't work, guess it's something on our end. Now it doesn't even say which test timed out.

sindresorhus · 2024-03-19T14:44:20Z

Works for me now: 64f0915

sindresorhus · 2024-03-20T06:10:26Z

Hmm, or maybe not. Maybe the problem here is tsimp. I never had any problems with tsx. Maybe worth trying that.

tommy-mitchell changed the title ~~rename~~ Rewrite in TypeScript Jan 28, 2024

tommy-mitchell mentioned this pull request Jan 28, 2024

Refactor #233

Open

9 tasks