Merge pull request #10 from sidmishraw/feature/code-cleanup

Feature/code cleanup Code clean up and add the requested features

Author: sidmishraw

.gitignore

@@ -1 +1,2 @@
-node_modules
+node_modules
+out

.vscode/extensions.json

@@ -7,21 +7,27 @@
             "type": "extensionHost",
             "request": "launch",
             "runtimeExecutable": "${execPath}",
-            "args": [
-                "--extensionDevelopmentPath=${workspaceRoot}"
-            ],
-            "stopOnEntry": false
+            "args": ["--extensionDevelopmentPath=${workspaceRoot}"],
+            "stopOnEntry": false,
+            "sourceMaps": true,
+            "outFiles": ["${workspaceRoot}/out/src/**/*.js"],
+            "preLaunchTask": "npm: compile"
         },
         {
             "name": "Launch Tests",
             "type": "extensionHost",
             "request": "launch",
             "runtimeExecutable": "${execPath}",
             "args": [
+                "${workspaceRoot}/testWorkspace.code-workspace",
+                "--extensions-dir=${workspaceRoot}/.", // no other extension loaded
                 "--extensionDevelopmentPath=${workspaceRoot}",
-                "--extensionTestsPath=${workspaceRoot}/test"
+                "--extensionTestsPath=${workspaceRoot}/out/test"
             ],
-            "stopOnEntry": false
+            "stopOnEntry": false,
+            "sourceMaps": true,
+            "outFiles": ["${workspaceRoot}/out/test/**/*.js"],
+            "preLaunchTask": "npm: compile"
         }
     ]
-}
+}

.vscode/launch.json

@@ -1,14 +1,15 @@
-// Place your settings in this file to overwrite default and user settings.
 {
-    "cSpell.words": [
-        "bitbucket",
-        "bulbasaur",
-        "doejohn",
-        "ivysaur",
-        "loginfo",
-        "rplc",
-        "topperv",
-        "venosaur",
-        "yababbdadado"
-    ]
-}
+    "files.exclude": {
+        "out": false // set this to true to hide the "out" folder with the compiled JS files
+    },
+    "search.exclude": {
+        "out": true // set this to false to include "out" folder in search results
+    },
+
+    "prettier.tabWidth": 4,
+    "prettier.singleQuote": true,
+    "prettier.trailingComma": "es5",
+
+    "typescript.tsdk": "./node_modules/typescript/lib", // we want to use the TS server from our node_modules folder to control its version
+    "typescript.tsc.autoDetect": "off"
+}

.vscode/settings.json

@@ -0,0 +1,18 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "type": "npm",
+            "script": "compile",
+            "problemMatcher": "$tsc-watch",
+            "isBackground": true,
+            "presentation": {
+                "reveal": "silent"
+            },
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        }
+    ]
+}

.vscode/tasks.json

@@ -6,64 +6,74 @@ Author: Sidharth Mishra
 
 All notable changes to the "topper" extension will be documented in this file.
 
+### [v1.0.0]
+
+**[!!!] This release has breaking changes and might need some configuration from your part for the first time you start using it –– especially on older files that were annotated with older versions of Topper. No worries for new users and new files.**
+
+-   Re-wrote the code from scratch in Typescript for better maintenance. Also got rid of the popup, it seems that the use of a keyboard shortcut is the best approach. The other way is to invoke command directly using the commands menu of vscode.
+-   The command palette now shows a command that is bound to the first profile in the list, no need for the popup –– this was made for streamlined usage. For a more streamlined approach, please use the keyboard shortcuts to the desired profiles.
+-   [CAUTION] Externalized the date formatting for created date and last modified date.
+-   [CAUTION] Externalized the last modified date capture regex in case the user defines their custom last modified date format.
+-   [CAUTION] Externalized the row and column indices to be used for insertion of the header string: use with care. Defaults to 0 for both row and col for sanity.
+
 ### [v0.4.0]
 
-- Merged pull request from @Drakesinger into master to allow more flexible formats for the `last modified` field in the headers. Thanks @Drakesinger for the PR!
+-   Merged pull request from @Drakesinger into master to allow more flexible formats for the `last modified` field in the headers. Thanks @Drakesinger for the PR!
 
-- Updated the readme document with more information about the `topper.lastModified` contribution point. Since, I had forgotten to add the description of this contribution point in the document I believe some of the users might have found it difficult to configure the `lastModified` field name in their headers. Sorry!
+-   Updated the readme document with more information about the `topper.lastModified` contribution point. Since, I had forgotten to add the description of this contribution point in the document I believe some of the users might have found it difficult to configure the `lastModified` field name in their headers. Sorry!
 
 ### [v0.3.2]
 
-- Fixed the issue [problem about last-modified when press cmd+s #3](https://github.com/sidmishraw/topper/issues/3). Now, topper's watcher listens to the `TextDocumentWillSaveEvent` and updates the last-modified field before the document saves.
+-   Fixed the issue [problem about last-modified when press cmd+s #3](https://github.com/sidmishraw/topper/issues/3). Now, topper's watcher listens to the `TextDocumentWillSaveEvent` and updates the last-modified field before the document saves.
 
 ### [v0.3.1]
 
-- Fixed the issue of Topper capturing templates of "last-modified". Now, there are strict patterns in place.
+-   Fixed the issue of Topper capturing templates of "last-modified". Now, there are strict patterns in place.
 
 ### [v0.3.0]
 
-- Fixed issue where the `@last-modified` field in the header was not getting updated automatically. Now, there is a configuration field `topper.lastModified` where the users can specify their custom field names for `last-modified` incase they do not use `@last-modified`. The default value is `@last-modified`.
+-   Fixed issue where the `@last-modified` field in the header was not getting updated automatically. Now, there is a configuration field `topper.lastModified` where the users can specify their custom field names for `last-modified` incase they do not use `@last-modified`. The default value is `@last-modified`.
 
 > Caveats: The implementation is choppy in some aspects because of limited support from VS Code APIs. Expect a better implementation in the next version.
 
-- Code cleanup.
+-   Code cleanup.
 
 ### [v0.2.0]
 
-- Code cleanup.
+-   Code cleanup.
 
-- Addition of profile specific shortcuts added to `keybinding.json` of VSCode:
+-   Addition of profile specific shortcuts added to `keybinding.json` of VSCode:
 
 ```json
-  {
+({
     "key": "cmd+shift+t 1",
     "command": "topper.addTopHeader.personalProfile"
-  },
-  {
+},
+{
     "key": "shift+cmd+t 2",
     "command": "topper.addTopHeader.officeProfile"
-  }
+})
 ```
 
 The first key combination is `Command + Shift + T` followed by a `1` or `2` depending on the profile. The user is free to bind any profile to any key combination.
 The commandId is of the form `topper.addTopHeader.<your-profile-name>`.
 
 ### [v0.1.0]
 
-- Stable release.
+-   Stable release.
 
 ### [v0.0.3]
 
-- Changed the extension's command from `extension.addTopHeader` to `topper.addTopHeader`. To make it easier for customized keybinding.
+-   Changed the extension's command from `extension.addTopHeader` to `topper.addTopHeader`. To make it easier for customized keybinding.
 
-- Code cleanup.
+-   Code cleanup.
 
 ### [v0.0.2]
 
-- Added support for multi line strings as values for the custom template parameters.
+-   Added support for multi line strings as values for the custom template parameters.
 
-- Updated `lastModifiedDate` to be fetched from the underlying OS. This is the true last modified date.
+-   Updated `lastModifiedDate` to be fetched from the underlying OS. This is the true last modified date.
 
 ### [v0.0.1]
 
-- Initial release of `Topper` extension. [Alpha]
+-   Initial release of `Topper` extension. [Alpha]