GitShow/sindresorhus/typescript-definition-style-guide
sindresorhus

typescript-definition-style-guide

Style guide for adding type definitions to my npm packages

by sindresorhus
style-guidetypescripttypescript-definitions
Star on GitHubFork
574 stars13 forks4 contributorsQuiet · 3y agoSince 2018CC-BY-4.0

Meet the team

See all 4 on GitHub →
sindresorhus
sindresorhus9 contributions
BendingBender
BendingBender2 contributions
shellscape
shellscape1 contribution
sonicdoe
sonicdoe1 contribution

Commit activity

Last 12 weeks · 0 commits

Full graph →

Community health

4 of 6 standards met

Community profile →
71
✓README✓License✓Contributing✓Code of Conduct○Issue Template○PR Template

Recent fixes

View closed PRs →
fregante
Replace textual guidelines with ESLint rules where possibleClosedIssue

Instead of a 590-words styleguide it could be shorter and the rest can be enforced by eslint, where automation is possible, like: Use tab-indentation and semicolons. Don't prefix the name of interfaces with ; , not : https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/interface-name-prefix.md Imports, destructuring, and object literals should not have spaces around the identifier; , not . Use the array shorthand type notation; number[], not Array. https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-array-constructor.md

fregante · 3y ago
UltiRequiem
Example of how to integrate `tsd` links to `tsd-check`, which is deprecatedClosedIssue

https://github.com/sindresorhus/typescript-definition-style-guide#testing !image !image Another example should be linked.

UltiRequiem · 4y ago
sindresorhus
Add recommendation for string-indexed objectsMergedPR
sindresorhus · 6y ago
Structured data for AI agents

Repository: sindresorhus/typescript-definition-style-guide. Description: Style guide for adding type definitions to my npm packages Stars: 574, Forks: 13. License: CC-BY-4.0. Topics: style-guide, typescript, typescript-definitions. Open PRs: 0, open issues: 0. Last activity: 3y ago. Community health: 71%. Top contributors: sindresorhus, BendingBender, shellscape, sonicdoe.

·@ofershap

Replace github.com with gitshow.dev