{"id":13523610,"url":"https://github.com/miyajan/jflint","last_synced_at":"2025-04-16T01:37:38.732Z","repository":{"id":57280633,"uuid":"82186119","full_name":"miyajan/jflint","owner":"miyajan","description":"A client tool to lint Jenkinsfile","archived":false,"fork":false,"pushed_at":"2018-10-16T08:52:02.000Z","size":18,"stargazers_count":42,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-10T09:58:27.567Z","etag":null,"topics":["jenkins","jenkinsfile","npm"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/miyajan.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-16T13:56:31.000Z","updated_at":"2025-02-24T08:25:22.000Z","dependencies_parsed_at":"2022-09-02T21:42:04.861Z","dependency_job_id":null,"html_url":"https://github.com/miyajan/jflint","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miyajan%2Fjflint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miyajan%2Fjflint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miyajan%2Fjflint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miyajan%2Fjflint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/miyajan","download_url":"https://codeload.github.com/miyajan/jflint/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249043199,"owners_count":21203429,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jenkins","jenkinsfile","npm"],"created_at":"2024-08-01T06:01:01.780Z","updated_at":"2025-04-16T01:37:38.694Z","avatar_url":"https://github.com/miyajan.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Jenkins-Tools"],"sub_categories":[],"readme":"# jflint\n\nA helper tool to lint a Declarative Jenkinsfile\n\n[![npm version](https://img.shields.io/npm/v/jflint.svg)](https://www.npmjs.com/package/jflint)\n[![npm downloads](https://img.shields.io/npm/dm/jflint.svg)](https://www.npmjs.com/package/jflint)\n![Node.js Version Support](https://img.shields.io/badge/Node.js%20support-v4–v7-brightgreen.svg)\n[![Build Status](https://travis-ci.org/miyajan/jflint.svg?branch=master)](https://travis-ci.org/miyajan/jflint)\n[![dependencies Status](https://david-dm.org/miyajan/jflint/status.svg)](https://david-dm.org/miyajan/jflint)\n[![Coverage Status](https://coveralls.io/repos/github/miyajan/jflint/badge.svg?branch=master)](https://coveralls.io/github/miyajan/jflint?branch=master)\n![License](https://img.shields.io/npm/l/jflint.svg)\n\n## Description\n\nThis tool helps to lint a Declarative Jenkinsfile.\n\n[The official document](https://github.com/jenkinsci/pipeline-model-definition-plugin/wiki/Validating-(or-linting)-a-Declarative-Jenkinsfile-from-the-command-line) provides a ssh approach and a curl approach to lint a Declarative Jenkinsfile. However, both approaches are a bit complicated for daily use.\n\nSo I created this tool to lint easily. **This tool itself does not lint a Jenkinsfile, but sends a request to Jenkins in the same way as curl approach and displays the result**.\n\n## Install\n\n```\n$ npm install jflint -g\n```\n\n## Usage\n\n```\n$ jflint [options] /path/to/Jenkinsfile\n```\n\n## Options\n\n### ```-j``` or ```--jenkins-url```\n\nSpecify the URL of Jenkins to lint Jenkinsfile. The URL must be passed by this option or a config file.\n\n### ```-u``` or ```--username```\n\nSpecify username for Jenkins. Username is required when security is enabled on Jenkins.\n\n### ```-p``` or ```--password```\n\nSpecify password or [API token](https://wiki.jenkins-ci.org/display/JENKINS/Authenticating+scripted+clients) for Jenkins. Password or API token is required when security is enabled on Jenkins.\n\n### ```--csrf-disabled```\n\nSpecify this options when CSRF security setting is disabled on Jenkins.\n\n### ```-c``` or ```--config```\n\nSpecify a path to config file.\n\n### ```--ssl-verification-disabled```\n\nDisable SSL verification.\n\n## Config file\n\nYou can load options from json file like the following.\n\n```json\n{\n  \"jenkinsUrl\": \"http://jenkins.example.com\",\n  \"username\": \"admin\",\n  \"password\": \"p@ssword\"\n}\n```\n\nConfig file is searched in the following order.\n\n* the path specified by ```-c|--config```\n* ```.jflintrc``` from the current directory all the way up to the filesystem root\n* ```${HOME}/.jflintrc```\n\nIf the same setting is specified in both option and config file, the option setting overrides the config setting.\n\n## Contribution\n\n1. Fork\n2. Create a feature branch\n3. Commit your changes\n4. Rebase your local changes against the master branch\n5. Run `npm test`\n6. Create new Pull Request\n\n## License\n\nMIT\n\n## Author\n\n[miyajan](https://github.com/miyajan): Jumpei Miyata miyajan777@gmail.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmiyajan%2Fjflint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmiyajan%2Fjflint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmiyajan%2Fjflint/lists"}