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 🙏

© 2021 – Pkg Stats / Ryan Hefner

lint-gitlab-ci

v1.1.1

Published

GitLab-ci script to lint .gitlab-ci.yml files.

Downloads

142

Readme

Lint GitLab CI

A module and cli that lints a .gitlab-ci.yml file, using the GitLab ci lint api.

Installing

npm install -g lint-gitlab-ci

Module

Basic usage

import lintGitlabCi from "lint-gitlab-ci";

lintGitlabCi().then((result) => {
    if (result.isValid) {
        console.log("Yay!");
    } else {
        console.log("Nay!");
    }
});

Options

import lintGitlabCi, { ILintGitlabCiOptions } from "lint-gitlab-ci";

const options: ILintGitlabCiOptions = {
    filePath: "example-ci.yml",
    api: {
        baseUrl: "https://example.com/api",
        version: "exampleVersion",
        paths: {
            lintCiYml: "example/path",
        },
    },
};

lintGitlabCi(options).then((result) => {
    if (result.isValid) {
        console.log("Yay!");
    } else {
        console.log("Nay!");
    }
});

Cli

Cli basic usage

lint-gitlab-ci

This will lint a .gitlab-ci.yml file and output any errors.

Specify file

To specify a different ci file, pass the filename as an argument.

lint-gitlab-ci example-ci.yml

Cli options

-u, --url

Specifies the GitLab api url to use - defaults to https://gitlab.com/api.

lint-gitlab-ci --url https://example.com/api

-a, --api-version

Specifies the GitLab api version to use - defaults to v4.

lint-gitlab-ci --api-version exampleVersion

-p, --ci-lint-path

Specifies the GitLab api ci linting path to use - defaults to ci/lint.

lint-gitlab-ci --ci-lint-path example/path

Integration with husky

Install lint-gitlab-ci and husky.

npm install -D lint-gitlab-ci husky

Configure husky to run the lint-gitlab-ci cli before committing.

{
    "husky": {
        "hooks": {
            "pre-commit": "lint-gitlab-ci"
        }
    }
}

This will validate the current .gitlab-ci.yml and block the commit if the file is invalid.

Credit

This project started as a TypeScript implementation of this project, but is now a completely new implementation.