https://github.com/timbeadle/cfpathcheck

Static analysis for cfml template import and include paths
https://github.com/timbeadle/cfpathcheck

cfm cfml-template checkstyle static-analysis

Last synced: about 1 month ago
JSON representation

Static analysis for cfml template import and include paths

• Host: GitHub
• URL: https://github.com/timbeadle/cfpathcheck
• Owner: timbeadle
• License: mit
• Created: 2015-11-13T10:05:24.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2025-03-24T20:42:07.000Z (about 2 months ago)
• Last Synced: 2025-03-27T04:23:02.482Z (about 2 months ago)
• Topics: cfm, cfml-template, checkstyle, static-analysis
• Language: JavaScript
• Size: 9.88 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cfpathcheck

Static analysis for cfml template import and include paths

[![npm version](https://img.shields.io/npm/v/cfpathcheck.svg)](https://www.npmjs.com/package/cfpathcheck)

[![Downloads/month](https://img.shields.io/npm/dm/cfpathcheck.svg)](https://www.npmjs.com/package/cfpathcheck)

[![Build Status](https://github.com/timbeadle/cfpathcheck/workflows/Node.js%20CI/badge.svg)](https://github.com/timbeadle/cfpathcheck)

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)

[![Code Climate](https://codeclimate.com/github/timbeadle/cfpathcheck/badges/gpa.svg)](https://codeclimate.com/github/timbeadle/cfpathcheck)

[![DepShield Badge](https://depshield.sonatype.org/badges/timbeadle/cfpathcheck/depshield.svg)](https://depshield.github.io)

[![Known Vulnerabilities](https://snyk.io/test/github/timbeadle/cfpathcheck/badge.svg)](https://snyk.io/test/github/timbeadle/cfpathcheck)

## Installation

  `(sudo) npm install -g cfpathcheck`

* Unix/Linux/Mac OS X: Note that sudo is required unless you have set your npm environment up not to need it

* Windows: Note that sudo doesn't exist ;o)

## Usage

  `cfpathcheck PATH [-r REPORTER -o OUTFILE]`

### Options

* PATH: The path to a single .cfm file, or to a directory containing .cfm files.

* REPORTER: use checkstyle to output checkstyle-compatible xml to stdout.

* OUTFILE: The path to the output file, for integration with (e.g.) Jenkins or other CI servers.

### Release support matrix

| Release | Min Node ver. | Support     |

| ------- | ------------- | ----------- |

| 1.x     | 4.0.0         | Obsolete    |

| 2.x     | 6.0.0         | Obsolete    |

| 3.x     | 8.0.0         | Obsolete    |

| 4.x     | 10.0.0        | Obsolete    |

| 5.x     | 12.0.0        | Obsolete    |

| 6.x     | 12.22.0       | Obsolete    |

| 7.x     | 14.13.0       | Obsolete    |

| 8.x     | 14.17.0       | Obsolete    |

| 9.x     | 16.14.0       | Obsolete    |

| 10.x    | 18.0.0        | Maintenance |

| 11.x    | 20.0.0        | Current     |

### Release history

* See [CHANGELOG](https://github.com/timbeadle/cfpathcheck/blob/main/CHANGELOG.md).