Giter VIP home page Giter VIP logo

cfnlinter's Introduction

cfnlinter

The cfnlint package is an AWS CloudFormation linter that uses the AWS CloudFormation Resource Specification and is customizable and extendible with a custom ruleset.

Package is available through pip:

pip install cfnlint

Current features

Upcoming features

  • Tests, linter, Code Conventions, etc.
  • Add Custom rules to extend/override the AWS specification
  • Lint against specific region
  • Add Pluggable system to add custom resource handlers for special/extended rules

Roadmap

Current planned roadmap:

Version Functionality
0.1.x Initialize release with basic functionality (yaml only). Customisation:
  • Allowed resources
  • Override required properties
  • Enumerators (Allowed values)
  • Top-level property support only
0.2.x Add json support. Customisation:
  • Additional documentation URL
  • Regular Expression support
  • Sub-properties support
0.3.x ?

Setup Virtual Environment

Optional but recommended. Example:

$ virtualenv -p python3 venv
$ source venv/bin/activate

Install requirements for development

$ pip install -e .

Test Application (CLI)

$ cfn-lint --cfn_file test_stack.yaml

cfnlinter's People

Contributors

fatbasstard avatar fvanboven avatar

Watchers

 avatar

Forkers

fvanboven

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.