Skip to content

refactor: strict typing and deprecation fix in type definitions #1573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

refactor: strict typing and deprecation fix in type definitions #1573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
64d0418
fix: deprecated-types
y-hsgw Apr 29, 2024
2c43334
refactor: remove type assertions and enhance strict typing
y-hsgw Apr 29, 2024
b030cc7
fix: addressed feedback and made necessary corrections
y-hsgw Apr 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ const plugin = {
| 'flat/all'
| 'flat/recommended'
| 'flat/style',
Pick<Required<TSESLint.Linter.Config>, 'rules'>
Pick<Required<TSESLint.ClassicConfig.Config>, 'rules'>
>,
environments: {
globals: {
Expand Down
2 changes: 1 addition & 1 deletion src/rules/__tests__/unbound-method.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ const toThrowMatchers = [
'toThrowError',
'toThrowErrorMatchingSnapshot',
'toThrowErrorMatchingInlineSnapshot',
];
] as const;

const validTestCases: string[] = [
...[
Expand Down
4 changes: 2 additions & 2 deletions src/rules/prefer-lowercase-title.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ export default createRule<
additionalProperties: false,
},
],
} as const,
},
defaultOptions: [
{ ignore: [], allowedPrefixes: [], ignoreTopLevelDescribe: false },
],
Expand Down Expand Up @@ -134,7 +134,7 @@ export default createRule<
if (
!firstCharacter ||
firstCharacter === firstCharacter.toLowerCase() ||
ignores.includes(jestFnCall.name as IgnorableFunctionExpressions)
ignores.includes(jestFnCall.name)
) {
return;
}
Expand Down
4 changes: 3 additions & 1 deletion src/rules/require-hook.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,11 @@ const shouldBeInHook = (
case AST_NODE_TYPES.ExpressionStatement:
return shouldBeInHook(node.expression, context, allowedFunctionCalls);
case AST_NODE_TYPES.CallExpression:
const nodeName = getNodeName(node);
Copy link
Collaborator

@G-Rath G-Rath Apr 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a runtime de-optimization - previously we'd only determine the node name if the other condition hasn't matched; now we'll always be getting the node name even if we don't need it


return !(
isJestFnCall(node, context) ||
allowedFunctionCalls.includes(getNodeName(node) as string)
(nodeName && allowedFunctionCalls.includes(nodeName))
);
case AST_NODE_TYPES.VariableDeclaration: {
if (node.kind === 'const') {
Expand Down
12 changes: 6 additions & 6 deletions src/rules/utils/__tests__/detectJestVersion.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ describe('detectJestVersion', () => {
it('finds the correct version', () => {
const projectDir = setupFakeProject({
'package.json': { name: 'simple-project' },
[`node_modules/${relativePathToFn}` as const]: compiledFn,
[`node_modules/${relativePathToFn}`]: compiledFn,
'node_modules/jest/package.json': {
name: 'jest',
version: '21.0.0',
Expand All @@ -133,7 +133,7 @@ describe('detectJestVersion', () => {
it('finds the correct version', () => {
const projectDir = setupFakeProject({
'package.json': { name: 'mono-repo' },
[`node_modules/${relativePathToFn}` as const]: compiledFn,
[`node_modules/${relativePathToFn}`]: compiledFn,
'node_modules/jest/package.json': {
name: 'jest',
version: '19.0.0',
Expand All @@ -153,13 +153,13 @@ describe('detectJestVersion', () => {
it('finds the correct versions', () => {
const projectDir = setupFakeProject({
'backend/package.json': { name: 'package-a' },
[`backend/node_modules/${relativePathToFn}` as const]: compiledFn,
[`backend/node_modules/${relativePathToFn}`]: compiledFn,
'backend/node_modules/jest/package.json': {
name: 'jest',
version: '24.0.0',
},
'frontend/package.json': { name: 'package-b' },
[`frontend/node_modules/${relativePathToFn}` as const]: compiledFn,
[`frontend/node_modules/${relativePathToFn}`]: compiledFn,
'frontend/node_modules/jest/package.json': {
name: 'jest',
version: '15.0.0',
Expand All @@ -184,7 +184,7 @@ describe('detectJestVersion', () => {
it('throws an error', () => {
const projectDir = setupFakeProject({
'package.json': { name: 'no-jest' },
[`node_modules/${relativePathToFn}` as const]: compiledFn,
[`node_modules/${relativePathToFn}`]: compiledFn,
'node_modules/pack/package.json': { name: 'pack' },
});

Expand All @@ -199,7 +199,7 @@ describe('detectJestVersion', () => {
it('uses the cached version', () => {
const projectDir = setupFakeProject({
'package.json': { name: 'no-jest' },
[`node_modules/${relativePathToFn}` as const]: compiledFn,
[`node_modules/${relativePathToFn}`]: compiledFn,
'node_modules/jest/package.json': { name: 'jest', version: '26.0.0' },
});

Expand Down
46 changes: 23 additions & 23 deletions src/rules/utils/__tests__/parseJestFnCall.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ ruleTester.run('expect', rule, {
parserOptions: { sourceType: 'script' },
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'expect',
type: 'expect',
Expand All @@ -220,7 +220,7 @@ ruleTester.run('expect', rule, {
parserOptions: { sourceType: 'module' },
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'expect',
type: 'expect',
Expand All @@ -246,7 +246,7 @@ ruleTester.run('expect', rule, {
parserOptions: { sourceType: 'module' },
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'expect',
type: 'expect',
Expand All @@ -272,7 +272,7 @@ ruleTester.run('expect', rule, {
parserOptions: { sourceType: 'module' },
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'expect',
type: 'expect',
Expand All @@ -298,7 +298,7 @@ ruleTester.run('expect', rule, {
parserOptions: { sourceType: 'module' },
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'expect',
type: 'expect',
Expand Down Expand Up @@ -327,7 +327,7 @@ ruleTester.run('expect', rule, {
parserOptions: { sourceType: 'module' },
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'expect',
type: 'expect',
Expand All @@ -343,7 +343,7 @@ ruleTester.run('expect', rule, {
line: 3,
},
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'expect',
type: 'expect',
Expand All @@ -359,7 +359,7 @@ ruleTester.run('expect', rule, {
line: 4,
},
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'expect',
type: 'expect',
Expand All @@ -375,7 +375,7 @@ ruleTester.run('expect', rule, {
line: 5,
},
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'expect',
type: 'expect',
Expand Down Expand Up @@ -493,7 +493,7 @@ if (eslintVersion >= 8) {
parserOptions: { sourceType: 'module', ecmaVersion: 2022 },
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'it',
type: 'test',
Expand All @@ -519,7 +519,7 @@ if (eslintVersion >= 8) {
parserOptions: { sourceType: 'module', ecmaVersion: 2022 },
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'it',
type: 'test',
Expand Down Expand Up @@ -630,7 +630,7 @@ ruleTester.run('global aliases', rule, {
code: 'context("when there is an error", () => {})',
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'describe',
type: 'describe',
Expand All @@ -652,7 +652,7 @@ ruleTester.run('global aliases', rule, {
code: 'context.skip("when there is an error", () => {})',
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'describe',
type: 'describe',
Expand All @@ -677,7 +677,7 @@ ruleTester.run('global aliases', rule, {
`,
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'xdescribe',
type: 'describe',
Expand All @@ -703,7 +703,7 @@ ruleTester.run('global aliases', rule, {
`,
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'describe',
type: 'describe',
Expand All @@ -719,7 +719,7 @@ ruleTester.run('global aliases', rule, {
line: 1,
},
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'describe',
type: 'describe',
Expand Down Expand Up @@ -794,7 +794,7 @@ ruleTester.run('global package source', rule, {
parserOptions: { sourceType: 'script' },
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'expect',
type: 'expect',
Expand Down Expand Up @@ -825,7 +825,7 @@ ruleTester.run('global package source', rule, {
parserOptions: { sourceType: 'module' },
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'describe',
type: 'describe',
Expand All @@ -841,7 +841,7 @@ ruleTester.run('global package source', rule, {
line: 3,
},
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'it',
type: 'test',
Expand All @@ -857,7 +857,7 @@ ruleTester.run('global package source', rule, {
line: 4,
},
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'expect',
type: 'expect',
Expand All @@ -884,7 +884,7 @@ ruleTester.run('global package source', rule, {
parserOptions: { sourceType: 'module' },
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'expect',
type: 'expect',
Expand All @@ -906,7 +906,7 @@ ruleTester.run('global package source', rule, {
code: 'context("when there is an error", () => {})',
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'describe',
type: 'describe',
Expand Down Expand Up @@ -1013,7 +1013,7 @@ ruleTester.run('typescript', rule, {
parserOptions: { sourceType: 'module' },
errors: [
{
messageId: 'details' as const,
messageId: 'details',
data: expectedParsedJestFnCallResultData({
name: 'it',
type: 'test',
Expand Down
4 changes: 2 additions & 2 deletions src/rules/valid-title.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,13 +74,13 @@ const compileMatcherPatterns = (
type CompiledMatcherAndMessage = [matcher: RegExp, message?: string];
type MatcherAndMessage = [matcher: string, message?: string];

const MatcherAndMessageSchema: JSONSchema.JSONSchema4 = {
const MatcherAndMessageSchema = {
type: 'array',
items: { type: 'string' },
minItems: 1,
maxItems: 2,
additionalItems: false,
} as const;
} as const satisfies JSONSchema.JSONSchema4;
Copy link
Collaborator

@G-Rath G-Rath Apr 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not strictly better than setting the type - there's no need to change this


type MatcherGroups = 'describe' | 'test' | 'it';

Expand Down