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

proper-tags

v2.0.2

Published

A few common utility template tags for ES2015

Downloads

13,054

Readme

proper-tags (common-tags rebooted)

npm version NPM Downloads No dependencies MIT License

proper-tags is an evolved version of the widely-used CommonJS package common-tags. It has been updated with the following considerations for modern JavaScript environments:

  • 🌟 Extendable: proper-tags comes with built-in tools for creating custom tags.
  • 📦 ESM Code Base: With support for ESM/ECMAScript Modules, it ensures native compatibility with modern development tools.
  • 🦕 Deno Compatibility: Designed specifically to function seamlessly with the Deno runtime.
  • 📝 TypeScript Definitions: Integrated TypeScript typings make development in TypeScript a breeze.
  • 🔄 API Consistency: Its interface aligns with common-tags, ensuring compatibility with existing frameworks and guides.

Below is a quick guide, check out the full documentation at https://proper-tags.56k.guru.

Quick Example

import { html } from 'proper-tags';

html`
  <div id="user-card">
    <h2>${user.name}</h2>
  </div>
`

Installation

Node

Install

npm install proper-tags

ESM Import:

import { stripIndent } from 'proper-tags';

Legacy CommonJS Require:

const { stripIndent } = require('proper-tags');

Deno

To use proper-tags with Deno, import it from deno.land:

import { html } from 'https://deno.land/x/proper_tags/dist/proper-tags.js';

Note: Make sure to freeze the url to a specific version

CDN/Browser

To include proper-tags via jsdelivr, add the following script tag to your HTML file:

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/proper-tags.umd.js"></script>

Note: Make sure to replace 2.0.2 with the latest version

Usage

Imports

Like all ES modules, proper-tags begins with an import.

import { stripIndent } from 'proper-tags'

Available Functions

  • html: Properly indents arrays and newline characters in string substitutions.
    • Aliases: source, codeBlock
  • safeHtml: Similar to html, but with safe HTML escaping for strings.
  • oneLine: Converts multi-line strings into a single line.
  • oneLineTrim: Converts multi-line strings into a single line, trimming newlines.
  • stripIndent: Strips the initial indentation from the beginning of each line in a multiline string.
  • stripIndents: Strips all indentation from the beginning of each line in a multiline string.
  • inlineLists: Inlines an array substitution as a list.
  • oneLineInlineLists: Inlines an array substitution as a list, rendered on a single line.
  • commaLists: Inlines an array substitution as a comma-separated list.
  • commaListsOr: Inlines an array as a comma-separated list, with the last item prefixed by "or".
  • commaListsAnd: Inlines an array as a comma-separated list, with the last item prefixed by "and".
  • oneLineCommaLists: Inlines an array as a comma-separated list on a single line.
  • oneLineCommaListsOr: Inlines an array as a comma-separated list on a single line, with the last item prefixed by "or".
  • oneLineCommaListsAnd: Inlines an array as a comma-separated list on a single line, with the last item prefixed by "and".
  • id: A no-op tag useful in scenarios like mocking.

For more information, examples, functions for advanced usage and best practices, refer to the documentation at proper-tags.56k.guru.

How to Contribute

Please see the Contribution Guidelines.

License

MIT. See license.