Skip to content

Commit

Permalink
Update OOXMLValidator (#28)
Browse files Browse the repository at this point in the history
- Closes #24
  • Loading branch information
mikeebowen committed Jan 25, 2024
1 parent 31bb9db commit 4b24683
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 10 deletions.
4 changes: 2 additions & 2 deletions OOXMLValidator/OOXMLValidatorCLI.deps.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"compilationOptions": {},
"targets": {
".NETCoreApp,Version=v6.0": {
"OOXMLValidatorCLI/1.2.0": {
"OOXMLValidatorCLI/2.1.3": {
"dependencies": {
"DocumentFormat.OpenXml": "3.0.1",
"MSTest.TestAdapter": "3.1.1",
Expand Down Expand Up @@ -351,7 +351,7 @@
}
},
"libraries": {
"OOXMLValidatorCLI/1.2.0": {
"OOXMLValidatorCLI/2.1.3": {
"type": "project",
"serviceable": false,
"sha512": ""
Expand Down
Binary file modified OOXMLValidator/OOXMLValidatorCLI.dll
Binary file not shown.
1 change: 1 addition & 0 deletions OOXMLValidator/OOXMLValidatorCLI.runtimeconfig.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"runtimeOptions": {
"tfm": "net6.0",
"rollForward": "Major",
"framework": {
"name": "Microsoft.NETCore.App",
"version": "6.0.0"
Expand Down
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@ The OOXML Validator validates Office Open XML files (.docx, .docm, .dotm, .dotx,
- Validates Office Open XML files against Office Perpetual 2007, 2010, 2013, 2016, 2019, 2021, or Microsoft 365 Subscription _Defaults to Microsoft 365 Subscription_
- Creates optional CSV or JSON log file of the errors.

## Requirements

The OOXML Validator requires that either the [.NET Install Tool for Extension Authors](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.vscode-dotnet-runtime) VS Code extension be installed or the `ooxml.dotNetPath` must be set in settings.json to the absolute path to the .Net Runtime.

## Usage

To validate an OOXML file, right click on the file to validate and select "Validate OOXML". This displays the validation errors in the VS Code window. If `ooxml.outPutFilePath` is set, a log of the validation errors is created (defaults to .csv).
Expand All @@ -33,7 +29,10 @@ This extension contributes the following settings:
- `ooxml.outPutFilePath`:
String that specifies the absolute file path to write the output of the validator. If the file name does not end in ".json" or ".csv", ".csv" will be appended to the filename and saved as a .csv file. Path **MUST** be absolute. If no value is set, no log file will be saved.
- `ooxml.overwriteLogFile`: If true, the new log file will overwrite previous log file of the same name if it exists. If false, a unique timestamp is added to the filename. Default is false.
- `ooxml.dotNetPath`: The absolute path to the .Net Runtime. Path **MUST** be absolute. If not set, the extension will use [.NET Install Tool for Extension Authors](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.vscode-dotnet-runtime) to download the .Net Runtime.
- `ooxml.dotNetPath`: The absolute path to the .Net Runtime. Path **MUST** be absolute. If not set, the extension will download the latest dotnet runtime.


> The path to the dotnet runtime executable will be similar to `"C:\\Program Files\\dotnet\\dotnet.exe"` for Windows and `"/usr/local/share/dotnet/dotnet"` for macos. For more information on finding the path to the dotnet executable, [this Stack Overflow post explains it for Windows](https://stackoverflow.com/questions/42588392/where-is-the-dotnet-command-executable-located-on-windows) and [this post explains how to find it on macos](https://stackoverflow.com/questions/41112054/where-is-the-default-net-core-sdk-path-in-macos).
## Release Notes

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"displayName": "OOXML Validator",
"description": "A VS Code extension for validating Office Open XML files",
"icon": "assets/icon.png",
"version": "1.5.3",
"version": "1.5.4",
"publisher": "mikeebowen",
"homepage": "https://github.com/mikeebowen/ooxml-validator-vscode/blob/master/README.md",
"repository": {
Expand All @@ -27,6 +27,9 @@
"onCommand:ooxml-validator-vscode.validateOOXML"
],
"main": "./dist/extension.js",
"extensionDependencies": [
"ms-dotnettools.vscode-dotnet-runtime"
],
"contributes": {
"configuration": {
"title": "OOXML",
Expand Down

0 comments on commit 4b24683

Please sign in to comment.