kazupon/textlint-rule-no-pair

support disallow options for built-in pairs

Open

#4 opened on May 28, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (0 forks)github user discovery
featuregood first issuestatus: pull request welcome🍰 p2-nice-to-have

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (PR metrics pending)

Description

Clear and concise description of the problem

As said in this section of the readme, textlint-rule-no-pairs has some built-in pairs to support the disallowPairs option.

As said in the textlint docs, it also supports other formats such as json and yaml. However, these cannot use the import syntax, so we cannot use the built-in pairs that textlint-rule-no-pair exports.

Suggested solution

The following options can be supported to enable built-in pairs in formats such as json as a disallow:

  • disallowParenthesis
  • disallowSquareBrackets
  • disallowCurlyBrackets
  • disallowFullWidthParenthesis
  • disallowFullWidthSquareBrackets
  • disallowFullWidthCurlyBrackets
  • disallowCornerBrackets
  • disallowWhiteCornerBrackets
  • disallowLessAndGreaterThanAngleBrackets
  • disallowLenticularBrackets
  • disallowWhiteLenticularBrackets
  • disallowWhiteSquareBrackets

These option names are a bit long and may be better abbreviated so that the meaning can be understood.

Alternative

No response

Additional context

No response

Validations

Contributor guide

Research direction
Inspect the current `disallowPairs` option implementation in the rule source code and decide where to add boolean options like `disallowParenthesis`. Then, implement the logic to merge these boolean options with the existing array based `disallowPairs` option, ensuring backward compatibility.
Tech stack
typescript
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScripttextlint rule development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65