Commit f44d8b84 authored by Wohlgemuth, Jason's avatar Wohlgemuth, Jason
Browse files

feat: Initial verified package structure with use-instead rule

parent f9d15c96
Loading
Loading
Loading
Loading
+7 −23
Original line number Diff line number Diff line
# ORNL
A [Vale-compatible](https://github.com/errata-ai/vale) linter style implements the editorial style of [Oak Ridge National Laboratory](https://ornl.gov)
# Science Vale Package
A [Vale-compatible](https://github.com/errata-ai/vale) style that implements the editorial style of [Oak Ridge National Laboratory](https://ornl.gov) and science, in general.

## Getting Started

Download the [latest release](), copy the "ORNL" directory to your `StylesPath`, and include it in your configuration file:
## Installation
Update your `.vale.ini` configuration with the following:

```ini
# This goes in a file named either `.vale.ini` or `_vale.ini`.
StylesPath = path/to/some/directory
MinAlertLevel = warning # suggestion, warning or error

# Only Markdown and .txt files; change to whatever you're using.
[*.{md,txt}]
# List of styles to load.
BasedOnStyles = ORNL
Packages = https://code.ornl.gov/research-enablement/vale-package/-/archive/v0.0.1/vale-package-v0.0.1.zip
BasedOnStyles = Science
```
 No newline at end of file

See the [documentation](https://vale.sh/) for more information.

## Repository Structure

<dl>
  <dt><a href="https://code.ornl.gov/research-enablement/ornl/tree/master/ORNL"><code>/ORNL</code></a></dt>
  <dd>The <a href="http://yaml.org/">YAML</a>-based rule implementations that make up our style.</dd>
</dl>
 No newline at end of file
+12 −0
Original line number Diff line number Diff line
extends: substitution
message: "Use '%s' instead of '%s'."
level: error
ignorecase: false
action:
  name: replace
swap:
  "geo-spatial": geospatial
  "utilize": use
  "utilizes": uses
  "utilized": used
  "utilizing": using
 No newline at end of file
+0 −0

File moved.

+62 −0
Original line number Diff line number Diff line
airflows?
applications?
basemaps?
beamlines?
bioeconomy
bioenerg(y|gies)
bioengineering
biofuels?
biomass
biomonitoring
bioproducts?
CPUs?
coproduct
cyber
[Cc]ybersecurity
deepfakes?
deliverables?
disable
downscaled?
drywell
fluence
GPUs?
[Gg]eomatics?
geometrical
geopositioning
geoprocessing
geoscience
geospatial
geotag(ged)?
glovebox(es)?
graphene
hackathons?
Hydrosource
irradiations?
IPs?
[Ll]idar
LLMs?
Mantid
misconfigurations?
multimodal
[Nn]anophase
[Nn]anoscale
nanomaterials?
operationalize
organoiodides?
parallel_for
parallel_reduce
Perlmutter
photogrammetric(ally)?
photogrammetry
QIS
Raman
regionalizations?
reusability
Situ
socioeconomics?
sorbents?
spaceborne
superfluidity
telematics
timeframes?
uncrewed
 No newline at end of file