https://github.com/articola-tools/file-path-validator

Tool to validate the name of a file that is used in Articola Tools organization's repositories
https://github.com/articola-tools/file-path-validator

articola articola-tools filename naming-convention validation

Last synced: 2 months ago
JSON representation

Tool to validate the name of a file that is used in Articola Tools organization's repositories

• Host: GitHub
• URL: https://github.com/articola-tools/file-path-validator
• Owner: Articola-Tools
• License: apache-2.0
• Created: 2024-11-20T21:25:53.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2025-03-05T15:57:29.000Z (3 months ago)
• Last Synced: 2025-03-05T16:41:43.095Z (3 months ago)
• Topics: articola, articola-tools, filename, naming-convention, validation
• Language: Go
• Homepage:
• Size: 22.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Articola Tools' file path validator

[![image size](https://ghcr-badge.egpl.dev/articola-tools/file-path-validator/size?color=dodgerblue)](https://ghcr-badge.egpl.dev/articola-tools/file-path-validator/size?color=dodgerblue)

This repo contains Dockerfile with preconfigured file paths validator written in

Go. The validator allows validating a file, and all folders in the provided

path are stick to the same naming convention. Currently, validator supports two

naming conventions - `snake_case` and `PascalCase`.

This linter is used in Articola Tools organization's repositories to validate

new files in PRs.

## Usage

Use `ghcr.io/articola-tools/file-path-validator` Docker image with two flags:

- `--naming-convention` - `snake_case` or `PascalCase`

- `--path-to-validate` - a file path to validate

Example command to use this linter:

```bash

docker run --rm ghcr.io/articola-tools/file-path-validator \

--naming-convention snake_case \

--path-to-validate "./repo/main.go"

```