Skip to content

Official TypeScript badge for READMEs #31569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
trivikr opened this issue May 23, 2019 · 21 comments
Closed

Official TypeScript badge for READMEs #31569

trivikr opened this issue May 23, 2019 · 21 comments
Labels
Committed The team has roadmapped this issue Suggestion An idea for TypeScript
Milestone

Comments

@trivikr
Copy link

trivikr commented May 23, 2019

Search Terms

badge, typescript badge

Suggestion

Official TypeScript badge (just like jest has one in their README)

Use Cases

There's no official badge for projects that use TypeScript.
There's an unofficial repo which provides different options for typescript badges https://github.com/ellerbrock/typescript-badges

@DanielRosenwasser DanielRosenwasser changed the title Official TypeScript badge in README? Official TypeScript badge for READMEs May 24, 2019
@DanielRosenwasser DanielRosenwasser added In Discussion Not yet reached consensus Suggestion An idea for TypeScript labels May 24, 2019
@DanielRosenwasser
Copy link
Member

DanielRosenwasser commented May 24, 2019

Would be interesting if we could get a Bᴜɪʟᴛ Wɪᴛʜ TʏᴘᴇSᴄʀɪᴘᴛ badge of some sort made.

@MartinJohns
Copy link
Contributor

@DanielRosenwasser I let my creative side flow free and created this badge for you: https://imgur.com/bLmkPCR

Feel free to use it!

@DanielRosenwasser
Copy link
Member

Damn that's good - it looks like it might say "BuiLt with TyreScrirt ❤", which I think kind of symbolizes how everyone sees something different in what they love about TypeScript.

@tonisostrat
Copy link

tonisostrat commented May 24, 2019

What about something like this? :D

@DanielRosenwasser
Copy link
Member

Okay, this is getting extremely competitive. I'm excited to see where the community goes with this.

@weswigham
Copy link
Member

TS Checked

@trivikr
Copy link
Author

trivikr commented May 24, 2019

image

@styfle
Copy link
Contributor

styfle commented May 24, 2019

Here's a couple made with https://badgen.net

ts

ts

![ts](https://badgen.net/badge/Built%20With/TypeScript/blue)

![ts](https://flat.badgen.net/badge/Built%20With/TypeScript/blue)

Update 1

I submitted a PR to add the TS logo badgen/badgen-icons#12

ts

ts

![ts](https://badgen.net/badge/-/TypeScript/blue?icon=typescript&label)

![ts](https://flat.badgen.net/badge/-/TypeScript/blue?icon=typescript&label)

Update 2

ts

ts

![ts](https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555)

![ts](https://flat.badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555)

Make your own here: https://badgen.net

@southpolesteve
Copy link

Can we have a special badge if the project enables strict mode? 🤗

@mceachen
Copy link

mceachen commented May 24, 2019

badge

badge

@fatcerberus
Copy link

Does anyone actually use tsc in loose mode nowadays? Other than for legacy reasons, of course. Enabling all the strict flags is literally the first thing I do in any new project now.

@fkleuver
Copy link

Does anyone actually use tsc in loose mode nowadays?

If you're being very nit-picky, TypeScript itself since they don't have the real 💪 strict mode enabled (strictFunctionTypes and strictBindCallApply are missing) ;)

@johnnyreilly
Copy link

How about a badge that is dynamically generated based upon your tsconfig.json. if it's completely strict then you get the black belt TypeScript badge?

@fenying
Copy link

fenying commented May 25, 2019

Maybe this could be simple?

Strict TypeScript Checked

[![Strict TypeScript Checked](https://badgen.net/badge/TS/Strict "Strict TypeScript Checked")](https://www.typescriptlang.org)

@fkleuver
Copy link

Maybe this could be simple?

Looks good, only thing it's missing is the 💪

@AnandChowdhary
Copy link

Jokes apart, some projects (including mine) use the convention “types | TypeScript” to signify that types are available. I think this is all that is necessary and we don’t need a badge specifically for projects written in TS.

Types

@RyanCavanaugh RyanCavanaugh added Committed The team has roadmapped this issue and removed In Discussion Not yet reached consensus labels Aug 20, 2019
@RyanCavanaugh RyanCavanaugh added this to the Backlog milestone Aug 20, 2019
@orta
Copy link
Contributor

orta commented Aug 20, 2019

I'm not really a README badges kinda person (I built my own markdown parser to get rid of them for CocoaPods) especially when it's duplicating GitHub chrome (like forks/stars/language...)

Though I see most of the value here is in showing the npm page and other derived READMEs.

Hopefully we can get npm to show types on their site like yarn does, but for now I think @AnandChowdhary probably has the right angle: showing folks they get types as they are exploring the ecosystem vs highlighting potential code quality improvements being created with TS.

Maybe this as the "official" one:

Typed with TypeScript

![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript&label&labelColor=blue&color=555555)

@hongbo-miao
Copy link

Found a badge used in Microsoft own repo microsoft/fast, which is

TypeScript

[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)

@alex-hedley
Copy link

Typescript

![Typescript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)

Source: https://dev.to/envoy_/150-badges-for-github-pnk

@RyelBanfield
Copy link

@DanielRosenwasser I let my creative side flow free and created this badge for you: https://imgur.com/bLmkPCR

Feel free to use it!

I love that I came here looking for a badge and this is what I found.

@trivikr
Copy link
Author

trivikr commented Jul 15, 2022

Closing this issue as the request was created three years ago, and there are multiple options for a TypeScript badge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Committed The team has roadmapped this issue Suggestion An idea for TypeScript
Projects
None yet
Development

No branches or pull requests