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

polymer-workspaces

v2.2.0

Published

Perform work across multiple GitHub repos

Downloads

156

Readme

polymer-workspaces

Perform work across multiple GitHub repos. Useful for both simple and complex changes across multiple Polymer elements, tools, and/or libraries.

npm install --save polymer-workspaces

Example: Creating a New Workspace

const {Workspace} = require('polymer-workspace');
const path = require('path');

const workspace = new Workspace({
  // Choose a "workspace" directory
  dir: path.resolve(process.cwd(), 'my-workspace'),
  // Choose your repos (glob-matching supported)
  include: [
    'Polymer/polymer',
    'PolymerElements/*#2.0-preview',
  ],
  // (Optional) Exclude some repos (glob-matching supported)
  excludes: ['PolymerElements/iron-ajax'],
  // Include a valid GitHub API token: https://github.com/blog/1509-personal-api-tokens
  token: 'GITHUB_API_TOKEN',
});

// Check out & set up the given repos from GitHub.
const workspaceRepos = await workspace.init();

// Optional: Install all required bower dependencies alongside the requested repos.
await workspace.installBowerDependencies();

Example: Running Tasks Across Repos

const {run} = require('polymer-workspace');

const {successes, failures} = await run(workspaceRepos, async(repo) => {
  // Contrived Example: Copy the "main" package.json property to "module"
  const packageManifestLoc = path.join(repo.dir, 'package.json');
  const packageManifestStr = fs.readFileSync(packageManifestLoc);
  const packageManifestJson = JSON.parse(packageManifestStr);
  packageManifestJson.module = packageManifestJson.main;
  fs.writeFileSync(packageManifestLoc, JSON.stringify(packageManifestJson));
});

// Remember to handle/report any errors:
for ([workspaceRepo, err] of failures) {
  console.log(workspaceRepo.dir, err.message);
}

Example: Pushing Multiple Repos

const {startNewBranch, run, commitChanges, pushChangesToGithub} = require('polymer-workspace');

await startNewBranch(workspaceRepos, 'new-branch-name');
await run(workspaceRepos, async(repo) => { /* ... */ });
await commitChanges(workspaceRepos, 'this is your new commit message!');
await pushChangesToGithub(workspaceRepos);

Example: NPM Publishing Multiple Repos

const {run, publishPackagesToNpm} = require('polymer-workspace');

await run(workspaceRepos, async(repo) => { /* ... */ });
await publishPackagesToNpm(workspaceRepos, 'next');