Typescript: Official TypeScript badge for READMEs

Created on 23 May 2019  ·  18Comments  ·  Source: microsoft/TypeScript

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

Committed Suggestion

Most helpful comment

badge

badge

All 18 comments

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

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

Feel free to use it!

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.

What about something like this? :D

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

TS Checked

image

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 https://github.com/badgen/badgen-icons/pull/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

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

badge

badge

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.

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) ;)

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?

Maybe this could be simple?

Strict TypeScript Checked

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

Maybe this could be simple?

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

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

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)

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/)
Was this page helpful?
0 / 5 - 0 ratings

Related issues

siddjain picture siddjain  ·  3Comments

wmaurer picture wmaurer  ·  3Comments

blendsdk picture blendsdk  ·  3Comments

zhuravlikjb picture zhuravlikjb  ·  3Comments

jbondc picture jbondc  ·  3Comments