update to version 0.2.0

Author: liqunkang

CHANGELOG.md

@@ -19,3 +19,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 ## [0.1.0] - 2023-10-14
 
 - Update of `patterns.json` file and `headings.md` file. Additional regular expressions added to the list used to parse the ORCA output file. Most frequently used keywords in the ORCA output file are now parsed. The list of regular expressions will be updated in future releases.
+
+## [0.2.0] - 2023-10-15
+
+- This version removed the previous `generate_patterns.py` script and the `headings.md` file. The list of regular expressions in `patterns.json` file is now more unversal and the matched text is displayed in the `ORCA FILE OUTLINE` view. Most of the keywords in the ORCA output file are in full capital letters, which is not very user friendly. The matched text is now converted to title case before being displayed in the `ORCA FILE OUTLINE` view. There is a list of keywords in the `keywords.json` file, which will be used to replace some of the converted matched text to its correct form. The list of keywords will be updated in future small releases.

README.md

@@ -4,15 +4,15 @@ This an extension for Visual Studio Code that provides a separate toggleable TOC
 
 ## Features
 
-This extension provides a separate toggleable TOC view in the sidebar. The TOC view is automatically populated with the contents of the ORCA output file that is currently open in the editor. The TOC view is generated by parsing the ORCA output file using regular expressions and setting up a tree view based on the results. The generated TOC view is a tree view with the titles of the headings in the ORCA output file and the corresponding line numbers. Clicking on a TOC entry will jump to the corresponding line in the ORCA output file. The TOC view can be toggled on and off by clicking on the `Orca Outline` icon in the sidebar. The TOC view can also be toggled on by running the command `Show Orca Outline` from the command palette. On Windows, the command palette can be opened with `Ctrl+Shift+P`, on Mac it is `Cmd+Shift+P`. The TOC view is automatically updated when navigating to a different ORCA output file.
+This extension provides a separate toggleable TOC view in the sidebar. The TOC view is automatically populated with the contents of the ORCA output file that is currently open in the editor. The TOC view is generated by parsing the ORCA output file using regular expressions and setting up a tree view based on the results. The generated TOC view is a tree view with the titles of the headings in the ORCA output file and the corresponding line numbers. Clicking on a TOC entry will jump to the corresponding line in the ORCA output file. The TOC view can be toggled on and off by clicking on the `ORCA FILE OUTLINE` icon in the sidebar. The TOC view can also be toggled on by running the command `Show ORCA Outline` from the command palette. On Windows, the command palette can be opened with `Ctrl+Shift+P`, on Mac it is `Cmd+Shift+P`. The TOC view is automatically updated when navigating to a different ORCA output file.
 
 ## Requirements
 
 N/A
 
 ## Extension Settings
 
-The current version (0.1.0) of this extension does not have any settings.
+The current version (0.2.0) of this extension does not have any settings.
 
 ## Known Issues
 
@@ -42,33 +42,32 @@ Added support for automatically showing TOC view when opening an ORCA output fil
 
 Update of `patterns.json` file and `headings.md` file. Additional regular expressions added to the list used to parse the ORCA output file. Most frequently used keywords in the ORCA output file are now parsed. The list of regular expressions will be updated in future releases.
 
+### 0.2.0
+
+This version removed the previous `generate_patterns.py` script and the `headings.md` file. The list of regular expressions in `patterns.json` file is now more unversal and the matched text is displayed in the `ORCA FILE OUTLINE` view. Most of the keywords in the ORCA output file are in full capital letters, which is not very user friendly. The matched text is now converted to title case before being displayed in the `ORCA FILE OUTLINE` view. There is a list of keywords in the `keywords.json` file, which will be used to replace some of the converted matched text to its correct form. The list of keywords will be updated in future small releases.
+
 ## TODO
 
 - [x] Automatically show TOC view when opening an ORCA output file
 - [ ] Automatically update TOC view when saving changes to an ORCA output file (additional command to manually refresh TOC view)
 - [ ] Add support for enabling/disabling TOC view for specific file types
 - [ ] Add support for controlling the showing level of TOC entries
 - [ ] Add illustrations to this README
-- [ ] Add icon to this extension
+- [x] Add icon to this extension
 - [x] Updating the list of regular expressions used to parse the ORCA output file
 
 ## Roadmap
 
-The current version represents a very early release of this extension. 
+The current version represents a very early release of this extension.
 
-The list of regular expressions in the `headings.md` file is parsed by converting each heading and the corresponding regular expression into a JSON object. The headings that will be displayed in the `ORCA FILE OUTLINE` is the heading text. This approach is not very flexible because some of the headings in the ORCA output file could be changed based on the type of calculation or in different versions of ORCA. In the next major release, the list of regular expressions will be more universal and the matched text will be displayed in the `ORCA FILE OUTLINE` view. The list of regular expressions will be updated in future releases. Most of the keywords in the ORCA output file are in full capital letters, which is not very user friendly. In the next major release, the matched text will be converted to title case before being displayed in the `ORCA FILE OUTLINE` view. There will be a list of keywords that will not be converted to title case. The list of keywords will be updated in future releases.
-
-Another feature that will be added in the next major release is to enable the scrolling of the `ORCA FILE OUTLINE` view to the current line in the ORCA output file. This will be useful when the ORCA output file is very long and the user is navigating through the file. The `ORCA FILE OUTLINE` view will automatically scroll to the current line in the ORCA output file.
+An important feature that will be added in the next major release is to enable the scrolling of the `ORCA FILE OUTLINE` view to the current line in the ORCA output file. This will be useful when the ORCA output file is very long and the user is navigating through the file. The `ORCA FILE OUTLINE` view will automatically scroll to the current line in the ORCA output file.
 
 ## For Developers
 
 The list of regular expressions is saved in `patterns.json` file. The file contains a list of regular expressions that are used to parse the ORCA output file. Each regular expression is a JSON object with the following properties:
 
 1. `regex`: The regular expression string
 2. `level`: The level of the TOC entry (1, 2, 3, etc.)
-3. `title`: The title of the TOC entry to be displayed in the TOC view
-
-It is easier to add new headings to the list of regular expressions by editing the `headings.md` file. This file contains a list of regular expressions that are used to parse the ORCA output file. The `generate_patterns.py` script is used to parse the `headings.md` file and generate the `patterns.json` file. The `patterns.json` file is used by the extension to parse the ORCA output file.
 
 Please submit a pull request if you would like to add a new regular expression to the list. Please also submit a pull request if you would like to modify an existing regular expression.
 

extension.js

@@ -4,13 +4,13 @@ const path = require('path');
 
 // Synchronously read orcaPatterns.json
 const orcaPatterns = JSON.parse(fs.readFileSync(path.join(__dirname, 'patterns.json'), 'utf8'));
+const keywordReplacements = JSON.parse(fs.readFileSync(path.join(__dirname, 'keywords.json'), 'utf8'));
 
 // Adjust regex patterns to RegExp objects
 orcaPatterns.forEach(pattern => {
     pattern.regex = new RegExp(pattern.regex, 'gm');
 });
 
-
 class OrcaOutlineProvider {
     constructor(matches) {
         this._matches = matches;
@@ -82,31 +82,6 @@ class OrcaOutlineProvider {
 
 let orcaOutlineProvider = new OrcaOutlineProvider([]);
 
-class OrcaDocumentSymbolProvider {
-    provideDocumentSymbols(document, token) {
-        const result = [];
-
-        orcaPatterns.forEach(pattern => {
-            let match;
-            while (match = pattern.regex.exec(document.getText())) {
-                const position = document.positionAt(match.index);
-                const range = new vscode.Range(position, position.translate(0, match[0].length));
-
-                const symbolInfo = new vscode.DocumentSymbol(
-                    pattern.title,
-                    '',
-                    pattern.level,
-                    range,
-                    range
-                );
-                result.push(symbolInfo);
-            }
-        });
-
-        return result;
-    }
-}
-
 function showOrcaOutline() {
     const activeEditor = vscode.window.activeTextEditor;
     if (!activeEditor) {
@@ -150,6 +125,12 @@ function activate(context) {
 
 function deactivate() {}
 
+function toTitleCase(str) {
+    return str.replace(/\w\S*/g, function(txt) {
+        return txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase();
+    });
+}
+
 function parseOrcaFile(document, filePath) {
     let matches = [];
     let stack = [{ children: matches }];  // A default root node for ease of algorithm
@@ -160,9 +141,16 @@ function parseOrcaFile(document, filePath) {
         let match;
         while (match = pattern.regex.exec(document.getText())) {
             const line = document.positionAt(match.index).line;
+            let title = match[1] || pattern.title;
+            title = toTitleCase(title.trim());
+            for (let keyword in keywordReplacements) {
+                if (title.includes(keyword)) {
+                    title = title.replace(keyword, keywordReplacements[keyword]);
+                }
+            }
             allMatches.push({
                 line: line,
-                title: pattern.title,
+                title: title,
                 level: pattern.level,
                 children: [],
                 command: {