npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ftapiat/ts-library-template

v1.1.1

Published

Plantilla para desarrollar paquetes de Javascript usando Typescript

Downloads

11

Readme

Paquetes NPM

Debes tener instalado npm y luego ejecutar el comando npm install.

Esto instalará:

  • Jest
  • EsLint
  • Prettier
  • Typescript

Modificaciones del template para proyecto

  • Debes eliminar la carpeta doc.
  • En package.json debes reemplazar:
    • @ftapiat/ts-library-template por el nombre de tu proyecto.
    • version por la versión de tu proyecto.
    • description por la descripción de tu proyecto.
    • keywords por las palabras clave de tu proyecto.
    • author por el autor de tu proyecto.
    • Los datos de repository por la url de repositorio de tu proyecto.
    • license por la licencia que usarás.
    • directories puedes eliminar doc si eliminaste la carpeta.
  • Si vas a desarrollar para una versión superior de ES5, debes modificar la propiedad target del archivo tsconfig.json.

EsLint

Este proyecto tiene implementado ESLint. Este es una herramienta de linting que se encarga de revisar el código de una forma automática y correcta.

Puede que al abrir el proyecto este esté desactivado, por lo que tendrás que activarlo manualmente. Si estás usando una herramienta de JetBrains como PHPStorm o WebStorm, puedes activarla en la sección Languages & Frameworks > Code Quality Tools > ESLint, seleccionando la opción Automatic ESLint configuration de la siguiente forma:

Captura para implementar EsLint en IntelliJ (PHPStorm)

Prettier

Este proyecto cuenta con Prettier, que es una herramienta que se encarga de formatear el código de una forma más bonita. Esto lo realiza corrigiendo o agregando espacios, cambiando las comillas dobles por comillas simples (según el contexto), etc.

Para asociarlo con el comando de JetBrains para formatear código (CTRL + ALT + L), debes dirigirte a Languages & Frameworks > JavaScript > Prettier, seleccionando la opción on 'Reformat Code' action de la siguiente forma:

Captura para mapear Prettier con el comando de formateo de Código en IntelliJ (PHPStorm)

Pruebas Jest

Escribir pruebas

Las pruebas deben estar escritas en la carpeta src/tests. Estas deben comprobar el funcionamiento correcto de cada clase, función, componente de la aplicación.

La extensión del archivo debe ser .test.ts.

Ejecutar pruebas

Las puedes ejecutar con el comando npm test.