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

@gojek/asphalt-web-tokens

v1.4.1

Published

Handles Asphalt Web default theme and tokens generation

Downloads

715

Readme

Asphalt Web Tokens

Tokens are the building block of our design system and foundation of theming. Asphalt Web Tokens acts as a bridge between components and theming by abstracting the logic of fetching & processing tokens and theme creation. It works as per the theme specification.

This package exports

  • legacy tokens as default export.
  • variables, theme & getTheme as named exports
    • variables: default tokens in form of CSS variables.
    • theme: default theme in compact format as per theme specification.
    • getTheme: function to get theme in any format for a set of tokens, it accepts tokens & format as parameters.

Theme has three formats -

  1. default - theme object with all properties of tokens, also referred as expanded form.
  2. compact - theme object with subset of token properties.
  3. legacy - object with CSS custom properties and their values.

Usage

Npm

npm install @gojek/asphalt-web-tokens

import { theme } from “@gojek/asphalt-web-tokens”

Yarn

yarn add @gojek/asphalt-web-tokens

import { theme } from “@gojek/asphalt-web-tokens”

Maintainers

Extracting tokens

Token Studio uses its sync feature to save the raw tokens into the token.json file within each theme.

Generating themes

  1. Open theme-generation.js script inside the scripts folder.

  2. Change the import statement import asphaltWebTokens from "../packages/asphalt-web-tokens/src/lib/token.json" assert { type: "json" }; to required theme's token.json.

    For example: import asphaltWebTokens from ../packages/theme-asphalt-web-aloha/token.json { type: "json" }

  3. Change the themeName parameter to a relevant name.

    For example: asphalt-web-aloha

  4. Run the script using node scripts/theme-generation.js

Contribution guidelines

  1. Clone the repository.
  2. Do the changes and make a PR against master branch.
  3. Once its merged and pipeline has succeded
  4. Run yarn run build
  5. Run yarn run release
  6. Run git push --follow-tags origin master to push the tags to origin.
  7. Run npm adduser --registry https://registry.npmjs.org, make sure you have permission to @gojek project on public npm, reach out to @detj for access.
  8. Run npm publish
  9. Create release for the tag manually on gitlab.