Skip to content

nthState/InclusiveCopywriting

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

InclusiveCopywriting javascript action

This action will scan specific files and report files containing non-inclusive words

Inputs

include_paths

Required A comma delimited list of paths/files to scan

exclude_words

Required A comma delimited list of bad words you want to find

file_types

A comma delimited list of file types to scan

warnings_as_errors

If a file is found to contain non-inclusive words, should we report that as an error?

Outputs

files_with_errors

A list of files that contain non-inclusive words

Example usages

- name: Check for non-inclusive words
        uses: nthState/InclusiveCopywriting@v1.1
        with:
          include_paths: './docs'
          exclude_words: 'simply, simple, easily, obviously, obvious, he, she, just, blacklist, whitelist, master, slave'
          file_types: '.md'
- name: Check for non-inclusive words
        uses: nthState/InclusiveCopywriting@v1.1
        with:
          include_paths: 'README.md, ./docs'
          exclude_words: 'simply, simple, easily, obviously, obvious, he, she, just, blacklist, whitelist, master, slave'
          file_types: '.md, .txt'
          warnings_as_errors: false

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published