Skip to content

Commit

Permalink
fix: can not import in ESM package (#159)
Browse files Browse the repository at this point in the history
<!-- πŸ‘‹ Hi, thanks for sending a PR to eslint-plugin-package-json! πŸ’–.
Please fill out all fields below and make sure each item is true and [x]
checked.
Otherwise we may not be able to review your PR. -->

## PR Checklist

-   [x] Addresses an existing open issue: fixes #152
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

<!-- Description of what is changed and how the code change does that.
-->

related #157
  • Loading branch information
hyoban committed Feb 20, 2024
1 parent 4911829 commit 2ce1881
Show file tree
Hide file tree
Showing 20 changed files with 30 additions and 27 deletions.
3 changes: 3 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,6 @@ trim_trailing_whitespace = true
[{package.json,*.yml}]
indent_size = 2
indent_style = space

[*.test.ts]
trim_trailing_whitespace = false
18 changes: 9 additions & 9 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import orderProperties from "./rules/order-properties.js";
import preferRepositoryShorthand from "./rules/prefer-repository-shorthand.js";
import sortCollections from "./rules/sort-collections.js";
import uniqueDependencies from "./rules/unique-dependencies.js";
import validLocalDependency from "./rules/valid-local-dependency.js";
import validName from "./rules/valid-name.js";
import validPackageDef from "./rules/valid-package-def.js";
import validRepositoryDirectory from "./rules/valid-repository-directory.js";
import validVersion from "./rules/valid-version.js";
import { rule as orderProperties } from "./rules/order-properties.js";
import { rule as preferRepositoryShorthand } from "./rules/prefer-repository-shorthand.js";
import { rule as sortCollections } from "./rules/sort-collections.js";
import { rule as uniqueDependencies } from "./rules/unique-dependencies.js";
import { rule as validLocalDependency } from "./rules/valid-local-dependency.js";
import { rule as validName } from "./rules/valid-name.js";
import { rule as validPackageDef } from "./rules/valid-package-def.js";
import { rule as validRepositoryDirectory } from "./rules/valid-repository-directory.js";
import { rule as validVersion } from "./rules/valid-version.js";

export const rules = {
"order-properties": orderProperties,
Expand Down
2 changes: 1 addition & 1 deletion src/rules/order-properties.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ type Order = "legacy" | "sort-package-json";

type Options = [{ order: Order }?];

export default createRule<Options>({
export const rule = createRule<Options>({
create(context) {
return {
"Program:exit"() {
Expand Down
2 changes: 1 addition & 1 deletion src/rules/prefer-repository-shorthand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const isGitHubUrl = (url: string) => githubUrlRegex.test(url);
const cleanGitHubUrl = (url: string) =>
url.replace(githubUrlRegex, "").replace(/\.git$/, "");

export default createRule({
export const rule = createRule({
create(context) {
return {
JSONProperty(node) {
Expand Down
2 changes: 1 addition & 1 deletion src/rules/sort-collections.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const defaultCollections = [

type Options = string[];

export default createRule<Options>({
export const rule = createRule<Options>({
create(context) {
const toSort = context.options[0] || defaultCollections;
return {
Expand Down
2 changes: 1 addition & 1 deletion src/rules/unique-dependencies.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const dependencyPropertyNames = new Set([
"overrides",
]);

export default createRule({
export const rule = createRule({
create(context) {
function check(
elements: (JsonAST.JSONNode | null)[],
Expand Down
2 changes: 1 addition & 1 deletion src/rules/valid-local-dependency.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import path from "path";

import { createRule } from "../createRule.js";

export default createRule({
export const rule = createRule({
create(context) {
return {
"Program:exit"() {
Expand Down
2 changes: 1 addition & 1 deletion src/rules/valid-name.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import validate from "validate-npm-package-name";

import { createRule } from "../createRule.js";

export default createRule({
export const rule = createRule({
create(context) {
return {
"Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.value=name]"(
Expand Down
2 changes: 1 addition & 1 deletion src/rules/valid-package-def.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const unusedErrorPatterns = [
const isUsableError = (errorText: string) =>
unusedErrorPatterns.every((pattern) => !pattern.test(errorText));

export default createRule({
export const rule = createRule({
create(context) {
return {
"Program:exit"() {
Expand Down
2 changes: 1 addition & 1 deletion src/rules/valid-repository-directory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import * as path from "node:path";
import { createRule } from "../createRule.js";
import { findPropertyWithKeyValue } from "../utils/findPropertyWithKeyValue.js";

export default createRule({
export const rule = createRule({
create(context) {
return {
"Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.value=repository][value.type=JSONObjectExpression]"(
Expand Down
2 changes: 1 addition & 1 deletion src/rules/valid-version.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import semver from "semver";

import { createRule } from "../createRule.js";

export default createRule({
export const rule = createRule({
create(context) {
return {
"Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.value=version]"(
Expand Down
2 changes: 1 addition & 1 deletion src/tests/rules/order-properties.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import rule from "../../rules/order-properties.js";
import { rule } from "../../rules/order-properties.js";
import { ruleTester } from "./ruleTester.js";

ruleTester.run("order-properties", rule, {
Expand Down
2 changes: 1 addition & 1 deletion src/tests/rules/prefer-repository-shorthand.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import rule from "../../rules/prefer-repository-shorthand.js";
import { rule } from "../../rules/prefer-repository-shorthand.js";
import { ruleTester } from "./ruleTester.js";

ruleTester.run("prefer-repository-shorthand", rule, {
Expand Down
2 changes: 1 addition & 1 deletion src/tests/rules/sort-collections.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import rule from "../../rules/sort-collections.js";
import { rule } from "../../rules/sort-collections.js";
import { ruleTester } from "./ruleTester.js";

//------------------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion src/tests/rules/unique-dependencies.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import rule from "../../rules/unique-dependencies.js";
import { rule } from "../../rules/unique-dependencies.js";
import { ruleTester } from "./ruleTester.js";

ruleTester.run("unique-dependencies", rule, {
Expand Down
2 changes: 1 addition & 1 deletion src/tests/rules/valid-local-dependency.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import path from "path";

import rule from "../../rules/valid-local-dependency.js";
import { rule } from "../../rules/valid-local-dependency.js";
import { ruleTester } from "./ruleTester.js";

const fileName = (partialPath: string) => {
Expand Down
2 changes: 1 addition & 1 deletion src/tests/rules/valid-name.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import rule from "../../rules/valid-name.js";
import { rule } from "../../rules/valid-name.js";
import { ruleTester } from "./ruleTester.js";

ruleTester.run("valid-name", rule, {
Expand Down
2 changes: 1 addition & 1 deletion src/tests/rules/valid-package-def.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import rule from "../../rules/valid-package-def.js";
import { rule } from "../../rules/valid-package-def.js";
import { ruleTester } from "./ruleTester.js";

ruleTester.run("valid-package-def", rule, {
Expand Down
2 changes: 1 addition & 1 deletion src/tests/rules/valid-repository-directory.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import rule from "../../rules/valid-repository-directory.js";
import { rule } from "../../rules/valid-repository-directory.js";
import { ruleTester } from "./ruleTester.js";

ruleTester.run("valid-repository-directory", rule, {
Expand Down
2 changes: 1 addition & 1 deletion src/tests/rules/valid-version.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import rule from "../../rules/valid-version.js";
import { rule } from "../../rules/valid-version.js";
import { ruleTester } from "./ruleTester.js";

ruleTester.run("valid-version", rule, {
Expand Down

0 comments on commit 2ce1881

Please sign in to comment.