create-typescript-app icon indicating copy to clipboard operation
create-typescript-app copied to clipboard

Feature: Have cspell automatically detect values from the package

Open orta opened this issue 1 year ago • 3 comments

Bug Report Checklist

  • [X] I have tried restarting my IDE and the issue persists.
  • [X] I have pulled the latest main branch of the repository.
  • [X] I have searched for related issues and found none that matched my issue.

Overview

Let's say I have made a module call "sdl-codegen"- when you run setup things like your username, the npm org, any words in the kebab case package name etc

Mainly so there's less surprises when you try get it green for the first time

Additional Info

orta avatar Apr 23 '23 17:04 orta

Yeah it's been annoying having to fill out assorted package names & such in each new package 😕. I want to say this is blocked on https://github.com/streetsidesoftware/cspell/issues/3215. Do you see any way around it @orta?

JoshuaKGoldberg avatar Apr 23 '23 21:04 JoshuaKGoldberg

Add it to the cspell file in the repo, that's how I solved it locally

orta avatar Apr 24 '23 05:04 orta

I use cspell paired with a custom script to populate the false positive in a separate file as new dictionary.

Script - https://github.com/timelessco/node-ts-app/blob/main/package.json#L46 Custom dictionary file - https://github.com/timelessco/node-ts-app/blob/main/project-words.txt Dictionary file added to the cspell config - https://github.com/timelessco/node-ts-app/blob/main/cspell.json#L22

navin-moorthy avatar Jun 10 '23 11:06 navin-moorthy