fix(eslint-plugin): [consistent-type-imports] import assertion checks added

[rielAsh24]

Added type assertion for json files

PR Checklist

• Addresses an existing open issue: fixes Bug: [consistent-type-imports] Incorrectly suggests import type on import assertion #7527
• That issue was marked as accepting prs
• Steps in Contributing were taken

 

Overview

This PR addresses the issue where typescript-eslint/eslint-plugin throws an error when an import statement with type imports includes an import assertions.

Reproduction Code:

import * as aJson from './a.json' assert { type: 'json' }

const what: aJson.A;

Actual Behaviour

typescript-eslint provides an invalid TypeScript code as a fix and hence had to be addressed by adding a rule that checks for such import type assertions.

Expected Behaviour

Since typescript 4.5, import assertions are supported, so No Error or All is Ok is the expected output.

 

Changes made:

1. Modified rule in consistent-type-imports.ts for type only import. Now it checks for absence of assertions and only then suggests the fix.

// checks for presence of import assertions
if (node.assertions.length === 0) {
  yield * fixInsertTypeSpecifierForImportDeclaration(fixer, node, false);
}

2. Tweaked reporting conditions in consistent-type-imports.ts for type only imports. Now it checks for absence of import assertions and only then reports the error.

/** checks if import has type assertions
 * ```
 * import * as type from 'mod' assert { type: 'json' };
 * ```
 * https://github.com/typescript-eslint/typescript-eslint/issues/7527
 */
if (report.node.assertions.length === 0) {
  context.report({
    node: report.node,
    messageId: "typeOverValue",
    *fix(fixer) {
      yield* fixToTypeImportDeclaration(fixer, report, sourceImports);
    }
  });
}

3. Added a rule to consistent-type-imports.test.ts which considers import assertion for json files as a valid rule.

  {
    code: `
      import * as Type from 'foo' assert { type: 'json' };
      const a: typeof Type = Type;
    `,
    options: [{ prefer: 'no-type-imports' }],
    dependencyConstraints: {
      typescript: '4.5',
    },
  },

[typescript-eslint]

Thanks for the PR, @rielAsh24!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

---

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

[netlify]

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	81f63d6
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/65269a352a2c260009d0fc9b
😎 Deploy Preview	https://deploy-preview-7722--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 99 (🟢 up 3 from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 98 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 81f63d6. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 19 targets

• nx test eslint-plugin --coverage=false
• nx test utils --coverage=false
• nx run types:build
• nx test visitor-keys --coverage=false
• nx test type-utils --coverage=false
• nx test typescript-estree --coverage=false
• nx test scope-manager --coverage=false
• nx run repo-tools:postinstall-script
• nx test repo-tools --coverage=false
• nx test parser --coverage=false
• nx test eslint-plugin-tslint --coverage=false
• nx test rule-schema-to-typescript-types --coverage=false
• nx test eslint-plugin-internal --coverage=false
• nx test ast-spec --coverage=false
• nx run-many --target=lint --parallel
• nx run-many --target=typecheck --parallel
• nx run integration-tests:test
• nx run eslint-plugin:generate:configs
• nx run-many --target=build --parallel --exclude=website --exclude=website-eslint

---

Sent with 💌 from NxCloud.

[JoshuaKGoldberg]

Thanks!

[rielAsh24]

Thanks!

Glad I could help! 😁