Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
suf-cli is a utility cli for automating readme stuff, like adding a license, most of the stuff below and above has been generated with this cli.
suf
this cli works by reading the suf.config.json
file, every cli module has its section in the config file, if you call the cli without any arguments it will ask you to create a config or it executes all modules present in the config, to add a module just execute the command for that module.
INFO: All arguments can start with - or --, but i would recommend to just use letters.
Command | |
---|---|
a | all | Calls all modules. |
b | badges | Calls the badges module. |
t | ts | d.ts | docs | Calls the tsDoc module. |
l | licence | Calls the license module. |
h | help | Displays this Message. |
interface BadgesModuleConfig {
/**package name */
name: string;
/**github username */
github: string;
/**vscode publisher.packageName */
vscode?: string;
/**github repo name */
repo: string;
/**path to readme or other target file */
out: string;
/**Array of badges */
badges: string[];
/**link to external config,(not sure if this still works) */
externalConfig?: string;
}
interface TsDocModuleConfig {
/**title displayed at the top of the generated text */
title: string;
/**path to the d.ts files */
dir: string;
/**path to readme or other target file */
out: string;
/**include all files in array, include and exclude cannot be used at the same time */
include?: string[];
/**exclude all files in array, include and exclude cannot be used at the same time */
exclude?: string[];
}
interface LicenseModuleConfig {
/**license type */
type: string;
/**license year */
year: string;
/**full name of the copyright holder */
name: string;
/**path to readme or other target file */
out: string;
/**path/name of the LICENSE file */
file: string;
}
interface ConfigFile {
badges?: BadgesModuleConfig;
tsDoc?: TsDocModuleConfig;
license?: LicenseModuleConfig;
}
interface Badges {
/** circleCi build. */
circleci: '/circleci/build/github/<GITHUB>/<REPO>';
/** codecov percentage. */
codecov: '/gh/<GITHUB>/<REPO>/branch/master/graph/badge.svg';
/** Vscode Extension Version. */
vscV: '/visual-studio-marketplace/v/<VSCODE>';
/** Vscode Extension downloads. */
vscD: '/visual-studio-marketplace/d/<VSCODE>';
/** Vscode Extension installs. */
vscI: '/visual-studio-marketplace/i/<VSCODE>';
/** Vscode Extension ratings. */
vscR: '/visual-studio-marketplace/r/<VSCODE>';
/** Bundlephobia Min. */
min: '/bundlephobia/min/<NAME>';
/** Bundlephobia Minzip. */
minzip: '/bundlephobia/minzip/<NAME>';
/** Packagephobia Install. */
install: '/packagephobia/install/<NAME>';
/** Packagephobia Publish. */
publish: '/packagephobia/publish/<NAME>';
/** Npm Version. */
npmV: '/npm/v/<NAME>';
/** Npm Weekly Downloads. */
npmDW: '/npm/dw/<NAME>';
/** Npm Monthly Downloads. */
npmDM: '/npm/dm/<NAME>';
/** Npm Yearly Downloads. */
npmDY: '/npm/dy/<NAME>';
/** Npm Total Downloads. */
npmDT: '/npm/dt/<NAME>';
/** Npm Types. */
npmTypes: '/npm/types/<NAME>';
/** Npm License. */
npmLicense: '/npm/license/<NAME>';
/** Npm Node. */
npmNode: '/npm/node/<NAME>';
/** Npm Dependents. */
npmDep: '/npm/dependents/<NAME>';
/** GitHub Followers. */
githubFollowers: '/github/followers/<GITHUB>';
/** GitHub Forks. */
githubForks: '/github/forks/<GITHUB>/<REPO>';
/** GitHub Starts. */
githubStars: '/github/stars/<GITHUB>/<REPO>';
/** GitHub Issues. */
githubIssues: '/github/issues/<GITHUB>/<REPO>';
/** GitHub Last Commit. */
githubLastCommit: '/github/last-commit/<GITHUB>/<REPO>';
/** Custom, usage example: badge=https://img.shields.io/badge/custom%2C-Badge-brightgreen. */
badge: '<CUSTOM>';
}
interface Links {
/** Npm package. */
npm: 'https://www.npmjs.com/package/<NAME>';
/** Github Repo. */
github: 'https://github.com/<GITHUB>/<REPO>';
/** circleCi Repo Pipelines. */
circleci: 'https://app.circleci.com/github/<GITHUB>/<REPO>/pipelines';
/** Visual Studio marketplace. */
vscode: 'https://marketplace.visualstudio.com/items?itemName=<VSCODE>';
/** Bundlephobia Link. */
bundle: 'https://bundlephobia.com/result?p=<NAME>';
/** Packagephobia Link. */
package: 'https://packagephobia.now.sh/result?p=<NAME>';
/** codecov Link. */
codecov: 'https://codecov.io/gh/<GITHUB>/<REPO>';
/** Custom, usage example: link=https://example.com. */
link: '<CUSTOM>';
}
Generated with suf-cli
Copyright (c) 2019 Leonard Grosoli Licensed under the MIT license.
FAQs
Utility Cli
The npm package suf-cli receives a total of 58 weekly downloads. As such, suf-cli popularity was classified as not popular.
We found that suf-cli demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.