Package Health Score

71 / 100

security
No known security issues
popularity
Limited
maintenance
Sustainable
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
1.5.2	\|	08/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.4.6	\|	02/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.4.4	\|	10/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.3.1	\|	11/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.11	\|	09/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (14)

GitHub Stars: 906
Forks: 65
Contributors: 20

Direct Usage Popularity

The npm package typewritten receives a total of 14 downloads a week. As such, we scored typewritten popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package typewritten, we found that it has been starred 906 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 20
Funding: Yes

With more than 10 contributors for the typewritten repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 5
Open PR: 1
Last Release: 3 months ago
Last Commit: 3 months ago

Further analysis of the maintenance status of typewritten based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that typewritten demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 years
Dependencies: 0 Direct
Versions: 28
Install Size: 60.7 kB
Dist-tags: 1
# of Files: 9
Maintainers: 1
TS Typings: No

typewritten has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

typewritten

A minimal zsh prompt

<img alt="All contributors" src="https://img.shields.io/badge/all_contributors-34-orange.svg?style=flat-square">

typewritten zsh prompt demo

> Terminal is iTerm2 — Font is JetBrains Mono — Terminal theme is Seoul256 > > See how to make your terminal look exactly like the demo here

Features

Asynchronous git info
Fully customizable

Quick start

npm

npm install -g typewritten

That's it. The script will make the necessary symlinks to fpath and set the prompt in your .zshrc.

Homebrew

brew install typewritten

Then load typewritten in your .zshrc by using zsh prompinit:

autoload -U promptinit; promptinit
prompt typewritten

Manual

Clone the typewritten repository somewhere you can easily link. I recommend creating a .zsh directory at root.

mkdir -p "$HOME/.zsh"
git clone https://github.com/reobin/typewritten.git "$HOME/.zsh/typewritten"

Load typewritten in your .zshrc by using zsh prompinit:

fpath+=$HOME/.zsh/typewritten
autoload -U promptinit; promptinit
prompt typewritten

Note: if using oh-my-zsh, set ZSH_THEME="" in your .zshrc to disable oh-my-zsh themes.

Other ways to install

Many other ways to install typewritten are available in the docs

Customization

typewritten is customizable in many ways. To keep the readme file as lean as possible, the documentation was moved to https://typewritten.dev.

The documentation is separated into two parts:

Prompt customization, everything to do with how and where the info is displayed
Prompt color customization, set a custom color for any of the prompt sections

Example of 3 customized typewritten prompts

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Robin Gagnon} 💻 🚧 📖	_thbe 💻	_{Erik Reinertsen} 💻 📖	_{Artem Zinnatullin :slowpoke:} 💻 📖	_Nizar 💻	_{John Letey} 📖	_Niranjan 💻
_Nikhil 🤔	_{Tobias Deekens} 🤔	_{Caleb Cushing} 🤔	_{Konstantin Petrov} 💻 📖	_{Krzysztof Tomasz Zembrowski} 📖	_{Ivan Velickovic} 📖	_{Jeremy Barisch-Rooney} 🤔
_Gino 🐛	_frdrk 🐛 📓	_{Huy Ha} 🐛 📓	_yanyan 💻	_{Louis de Charsonville} 🐛 💻	_{Jack Chapman} 💻 🐛	_GPSBach 💻 🤔
_{Will Lorey} 📖	_{Gabriel Ataide} 🐛 💻	_Scupake 🤔 ⚠️	_{Crystal Adkins} 💻 🤔	_J.B.C 🐛 💻	_{Jeeva K} 🐛 🤔	_awakened 🤔
_spamwax 🤔	_{Austin Ray} 💻 🐛	_Alan 🐛	_{Vedant Nandwana} 📖	_{Kyle Dozier} 📖 🤔	_{Daniel Bayley} 💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Supporters 🌞

Credits

pure layout is inspired by Pure
npm install and uninstall scripts are from Spaceship prompt

FAQs

What is typewritten?

A minimal, lightweight, informative zsh prompt theme. Visit Snyk Advisor to see a full health score report for typewritten, including popularity, security, maintenance & community analysis.

Is typewritten popular?

The npm package typewritten receives a total of 14 weekly downloads. As such, typewritten popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is typewritten well maintained?

We found indications that typewritten maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is typewritten safe to use?

The npm package typewritten was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 7 November-2024, at 21:27 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP