Scarf-package NPM

scarf-package

Add a scarf package with API

Install

npm install scarf-package

Usage

const scarfPackage = require('scarf-package');

(async () => {
	const pkg = {name: `cli-meow-help`};
	const res = await scarfPackage(pkg);

	if (res.status === 200) {
		console.log(`SUCCESS: ${pkg.name} added!`);
	} else {
		console.log(`Failed`);
		console.log(res);
	}
})();

API

scarfPackage(options)

❯ options

Type: object Default: ↓

{
	username: undefined,
	apiKey: undefined,
	name: undefined,
	desc = '',
	externalLibraryType = 'npm'
}

You can specify the options below.

❯ username

Type: string Default: undefined

Required username of Scarf.sh site.

❯ username

Type: string Default: undefined

Required API Token of Scarf.sh site. Find it in your user account settings page.

❯ name

Type: string Default: undefined

Required name of the package.

❯ desc

Type: string Default: '' (optional)

Optional short description of the package.

❯ externalLibraryType

Type: string Default: 'npm' (optional)

Type of the external library.

Changelog

❯ Read the changelog here →

KEY: 📦 NEW, 👌 IMPROVE, 🐛 FIX, 📖 DOC, 🚀 RELEASE, and 🤖 TEST

I use Emoji-log, you should try it and simplify your git commits.

License & Conduct

MIT © Ahmad Awais
Code of Conduct

Connect

Sponsor

Me (Ahmad Awais) and my incredible wife (Maedah Batool) are two engineers who fell in love with open source and then with each other. You can read more about me here. If you or your company use any of my projects or like what I’m doing then consider backing me. I'm in this for the long run. An open-source developer advocate.

NodeCLI.com — Learn to build Node.js CLI Automation

This repository is part of the NodeCLI.com course.

After building hundreds of developer automation tools used by millions of developers, I am sharing exactly how you can do it yourself with minimum effective effort. Learn to build Node.js & JavaScript based CLI (Command Line Interface) apps. Automate the grunt work, do more in less time, impress your manager, and help the community. → I'm sharing it all in this online video course. Node CLI Automation without wasting a 1,000 hours →