[docs] Update README

.github/workflows/CI.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Apply problem matcher
         uses: ./
         with:
-          build-directory: ""
+          build-directory: build/
       
       - name: Test problem matcher
         run: |

README.md

@@ -1,21 +1,25 @@
 # GCC problem matcher
 
-# DO NOT COMMIT THIS LINE
-
 Creates annotations for warnings and errors in gcc builds.
 
 ## Inputs
 
-### root
+### build-directory
 
 **Optional** Base directory for build. For builds done in a subdirectory, this should match that directory, otherwise the pattern match will not be able to point to the correct file.
 
 ## Example usage
 
-Just add this line anywhere before running the build step.
+Create annotations for builds done in the root directory
+
+```yaml
+    - uses: olemorud/gcc-problem-matcher@v1.0
+```
+
+Create annotations for builds done in directory `/workspace/build/`
 
 ```yaml
     - uses: olemorud/gcc-problem-matcher@master
       with:
-        root: /workspace/build
+        build-directory: /workspace/build/
-```
+```

action.yml

@@ -1,4 +1,4 @@
-name: GCC Problem Matcher
+name: GCC Problem Matcher Improved
 
 description: Get annotations for warnings and errors on builds using gcc
 
@@ -11,8 +11,8 @@ branding:
 inputs:
   build-directory:
     description: 'base directory for build, e.g. /workdir/build'
-    required: true
+    required: false
 
 runs:
   using: 'node16'
-  main: 'dist/index.js'
+  main: 'dist/index.js'

dist/gcc_matcher.jsontemplate

@@ -4,7 +4,7 @@
             "owner": "gcc-problem-matcher",
             "pattern": [
                 {
-                    "regexp": "^\\s*${{ BASE }}\/?(.*?):(\\d+):(\\d+):.*?(warning|error): (.*)$"
+                    "regexp": "^${{ BASE }}\\/?(.*?):(\\d+):(\\d*):?\\s+(?:fatal\\s+)?(warning|error):\\s+(.*)$",
                     "file": 1,
                     "line": 2,
                     "column": 3,

dist/index.js

@@ -2848,7 +2848,7 @@ const core = __nccwpck_require__(127);
 // escapeRegExp :: string => string
 // escape all characters with special meanings in regexp
 const escapeRegExp = (s) =>
-	s.replace(/[/\-^$*+?.()|[\]{}]/g, "\\$&");
+	s.replace(/[/\-^$*+?.()|[\]{}]/g, "\\\\$&");
 
 // variable :: string => RegExp
 // create regex to match ${{ key }}
@@ -2859,12 +2859,12 @@ const variable = (key) =>
 const templatePath = __nccwpck_require__.ab + "gcc_matcher.jsontemplate";
 
 // matcherPath :: string
-const matcherPath = __nccwpck_require__.ab + "gcc_matcher.json";
+const outputPath = __nccwpck_require__.ab + "gcc_matcher.json";
 
 // rootdir :: string
 const rootdir = core.getInput('build-directory', {required: false});
 
-// parse :: IO() => IO() => Error | null
+// parse :: string => string => Error | null
 const parse = (templatePath) => (matcherPath) => {
 	const content = fs.readFileSync(templatePath, 'utf-8');
 

src/gcc_matcher.jsontemplate

@@ -4,7 +4,7 @@
             "owner": "gcc-problem-matcher",
             "pattern": [
                 {
-                    "regexp": "^\\s*${{ BASE }}\/?(.*?):(\\d+):(\\d+):.*?(warning|error): (.*)$"
+                    "regexp": "^${{ BASE }}\\/?(.*?):(\\d+):(\\d*):?\\s+(?:fatal\\s+)?(warning|error):\\s+(.*)$",
                     "file": 1,
                     "line": 2,
                     "column": 3,

src/index.js

@@ -5,7 +5,7 @@ const core = require('@actions/core');
 // escapeRegExp :: string => string
 // escape all characters with special meanings in regexp
 const escapeRegExp = (s) =>
-	s.replace(/[/\-^$*+?.()|[\]{}]/g, "\\$&");
+	s.replace(/[/\-^$*+?.()|[\]{}]/g, "\\\\$&");
 
 // variable :: string => RegExp
 // create regex to match ${{ key }}
@@ -16,12 +16,12 @@ const variable = (key) =>
 const templatePath = path.join(__dirname, "gcc_matcher.jsontemplate");
 
 // matcherPath :: string
-const matcherPath = path.join(__dirname, "gcc_matcher.json");
+const outputPath = path.join(__dirname, "gcc_matcher.json");
 
 // rootdir :: string
 const rootdir = core.getInput('build-directory', {required: false});
 
-// parse :: IO() => IO() => Error | null
+// parse :: string => string => Error | null
 const parse = (templatePath) => (matcherPath) => {
 	const content = fs.readFileSync(templatePath, 'utf-8');
 
@@ -34,7 +34,7 @@ const parse = (templatePath) => (matcherPath) => {
 
 // main:
 try {
-	parse(templatePath)(matcherPath);
+	parse(templatePath)(outputPath);
 } catch (err) {
 	core.setFailed(`Action failed with error ${err}`)
 }