Evaluate (and implement) Textlint
Open, LowestPublic
Actions

Assigned To

None

Authored By

	Volker_E
	Oct 18 2022, 6:15 AM

Description

Background

We're humans, there are machines. Let them help us.

Textlint is an incredible powerful tool with a number of plugins that would perfectly accomplish our code quality tools

Plugins

https://github.com/io-monad/textlint-rule-common-misspellings based on Wikipedia's common misspellings
https://github.com/textlint-rule/textlint-rule-rousseau
https://github.com/sapegin/textlint-rule-stop-words

Unconvincing plugins

https://github.com/textlint-rule/textlint-rule-alex too many false positives

Acceptance criteria

Evaluate Textlint on dependency, performance and its usefulness
- Implement

Details

	Subject	Repo	Branch	Lines +/-
	[WIP] build: Add textlint and plugins	design/codex	main	+3 K -77

Customize query in gerrit

Related Objects

Mentioned Here: T313540: docs/build: Increase easy or automatic resolution of minor code issues

Event Timeline

Volker_E created this task.Oct 18 2022, 6:15 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 18 2022, 6:15 AM

Volker_E renamed this task from Evaluate (and implement Textlint to Evaluate (and implement) Textlint.Oct 18 2022, 6:15 AM

Volker_E updated the task description. (Show Details)Oct 18 2022, 6:25 AM

Change 843867 had a related patch set uploaded (by VolkerE; author: VolkerE):

[design/codex@main] [WIP] build: Add textlint and plugins

https://gerrit.wikimedia.org/r/843867

gerritbot added a project: Patch-For-Review.Oct 18 2022, 6:35 AM

Volker_E updated the task description. (Show Details)Oct 18 2022, 6:55 AM

What I think would, the dependency and performance question clarified, make sense is to rely on common-misspellings. We could start only there.

Volker_E added a parent task: T315588: [EPIC] Make it easier to use Codex, improve designer and developer experience.Oct 19 2022, 4:01 AM

+1 for just adding common misspellings! That, plus a recommendation to use a spell checker plugin could help us a lot with typos (see T313540)

Change 843867 abandoned by VolkerE:

[design/codex@main] [WIP] build: Add textlint and plugins

Reason:

Textlint didn't find more friends. Let's abandon for now.

https://gerrit.wikimedia.org/r/843867

Not convincing to the peers. Putting on the backseat for now.

Volker_E removed a project: Patch-For-Review.Oct 27 2022, 10:09 AM

@Volker_E - can you please put an initial/proposed priority level on this task and move it to the Backlog column?
DST prioritization guidance

Volker_E triaged this task as Lowest priority.Jan 23 2023, 5:52 AM

Volker_E moved this task from Inbox to Backlog on the Design-System-Team board.Jan 23 2023, 6:53 AM

ldelench_wmf moved this task from Inbox to Codex Adoption on the Codex board.Feb 17 2023, 11:50 PM

ldelench_wmf removed a parent task: T315588: [EPIC] Make it easier to use Codex, improve designer and developer experience.Feb 17 2023, 11:52 PM

Evaluate (and implement) TextlintOpen, LowestPublicActions