Finish Enhance_documentation

Author: WilliamDelRey

CHANGELOG.md

@@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
 
+
+## [Unreleased]
+
+
+### Fixed
+
+- Fixed Typo in the readme
+- Fixed LivecodeServerExecutablePath no applying correctly
+
+### Added
+
+- Basic documentation on Readme.md
+
+### Removed
+
+- Removed unused configuration entry
+
+
 ## [1.0.4] - 2022-01-22
 
 ### Added

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing
+
+Thanks for considering contributing to Default!
+
+## Opening issues
+
+If you find a bug, please feel free to [open an issue](https://github.com/ferruslogic/vscode-livecodescript/issues).
+
+If you taking the time to mention a problem, even a seemingly minor one, it is greatly appreciated, and a totally valid contribution to this project. Thank you!
+
+## Fixing bugs
+
+We love pull requests. Here’s a quick guide:
+
+1. [Fork this repository](https://github.com/ferruslogic/default/fork) and then clone it locally:
+
+  ```bash
+  git clone https://github.com/ferruslogic/default
+  ```
+
+2. Create a topic branch for your changes:
+
+  ```bash
+  git checkout -b fix-for-that-thing
+  ```
+3. Commit a failing test for the bug:
+
+  ```bash
+  git commit -am "Adds a failing test to demonstrate that thing"
+  ```
+
+4. Commit a fix that makes the test pass:
+
+  ```bash
+  git commit -am "Adds a fix for that thing!"
+  ```
+
+5. Run the tests:
+
+  ```bash
+  npm test
+  ```
+
+6. If everything looks good, push to your fork:
+
+  ```bash
+  git push origin fix-for-that-thing
+  ```
+
+7. [Submit a pull request.](https://help.github.com/articles/creating-a-pull-request)
+
+8. Enjoy being the wonderful person you are
+
+  After you’ve opened your pull request, [you should email me](mailto:[email protected]) your mailing address so I can mail you a personal thank you note. Seriously!
+
+## Adding new features
+
+Thinking of adding a new feature? Cool! [Open an issue](https://github.com/ferruslogic/default/issues) and let’s design it together.

README.md

@@ -4,14 +4,44 @@
 
 [![CI](https://github.com/ferruslogic/vscode-livecodescript/actions/workflows/ci.yml/badge.svg)](https://github.com/ferruslogic/vscode-livecodescript/actions/workflows/ci.yml) [![CI](https://badgen.net/vs-marketplace/v/ferruslogic.livecodescript)](https://marketplace.visualstudio.com/items?itemName=ferruslogic.livecodescript)
 
-## Features
 
-Learn more about the rich features of the Python extension:
+# Features
+
+Lots of new improvements happening! We now have a CHANGELOG.md
+
+## General Features
+
+Learn more about the rich features of the Livecode extension:
 
 - Linting
 - Format your code
 - Syntax highlighting
-- Go to definition
+- Go to definition (across opened documents)
 - Outline
 - Breadcrumbs
 
+
+
+## Usage
+
+Install the [VSCode Livecode Extension](https://marketplace.visualstudio.com/items?itemName=FerrusLogic.livecodescript).
+
+
+**This extension requires Livecode server i order to support linting and formating**.
+
+Dowload and install livecode-server. When the plugin is loaded it will ask for Livecode-server executable. 
+
+
+
+
+## Contributing
+
+Contributions are welcome. Read more at [Contribute](CONTRIBUTING.md)
+
+
+
+
+
+# License
+
+[BSD 3](LICENSE.md) © FerrusLogic

package.json

@@ -29,19 +29,14 @@
             "title": "Livecodescript",
             "type": "object",
             "properties": {
-                "livecodescript.suggest.basic": {
-                    "type": "boolean",
-                    "default": true,
-                    "description": "test1"
-                },
                 "livecodescript.validate.enable": {
                     "type": "boolean",
                     "default": true,
-                    "description": "test2"
+                    "description": "Enable code validation"
                 },
-                "livecodescript.validate.executablePath": {
+                "livecodescript.LivecodeServerExecutablePath": {
                     "type": "string",
-                    "default": "C:\\lc-server\\livecode-server.exe",
+                    "default": "",
                     "description": "Executable Path"
                 },
                 "livecodescript.validate.run": {

src/features/format.ts

@@ -4,7 +4,7 @@ import * as path from 'path';
 
 
 const enum Setting {
-	ExecutablePath = 'livecodescript.validate.executablePath',
+	LivecodeServerExecutablePath = 'livecodescript.validate.LivecodeServerExecutablePath',
 }
 
 
@@ -18,9 +18,9 @@ export class LivecodescriptFormattingProvider implements vscode.DocumentRangeFor
 
         // if perltidy is not defined, then skip the formatting
         let config = vscode.workspace.getConfiguration('livecodescript');
-        let executable = config.get("executablePath", "");
+        let executable = config.get("LivecodeServerExecutablePath", "");
 
-        if (!vscode.workspace.getConfiguration('livecodescript').get("executablePath")) {
+        if (!vscode.workspace.getConfiguration('livecodescript').get("LivecodeServerExecutablePath")) {
             return [];
         }
 
@@ -33,7 +33,7 @@ export class LivecodescriptFormattingProvider implements vscode.DocumentRangeFor
             }
 
             let config = vscode.workspace.getConfiguration('livecodescript');
-            let executable = config.get("executablePath", "");
+            let executable = config.get("LivecodeServerExecutablePath", "");
 
             let args: string[] = [(path.resolve(__dirname, '../../tools/Formatter.lc')).replace(/[\\]+/g,"/"), '-scope=.source.livecodescript'];
 

src/features/validationProvider.ts

@@ -15,7 +15,7 @@ let localize = nls.loadMessageBundle();
 const enum Setting {
 	Run = 'livecodescript.validate.run',
 	Enable = 'livecodescript.validate.enable',
-	ExecutablePath = 'livecodescript.executablePath',
+	LivecodeServerExecutablePath = 'livecodescript.LivecodeServerExecutablePath',
 }
 
 export class LineDecoder {
@@ -177,7 +177,7 @@ export default class LivecodescriptValidationProvider {
 		return new Promise<void>(resolve => {
 			const executable = this.config!.executable;
 			if (!executable) {
-				this.showErrorMessage(localize('noLivecode', 'Cannot validate since a Livecode installation could not be found. Use the setting \'livecodescript.validate.executablePath\' to configure the Livecode executable.'));
+				this.showErrorMessage(localize('noLivecode', 'Cannot validate since a Livecode installation could not be found. Use the setting \'livecodescript.LivecodeServerExecutablePath\' to configure the Livecode executable.'));
 				this.pauseValidation = true;
 				resolve();
 				return;
@@ -252,9 +252,9 @@ export default class LivecodescriptValidationProvider {
 		let message: string | null = null;
 		if (error.code === 'ENOENT') {
 			if (this.config!.executable) {
-				message = localize('wrongExecutable', 'Cannot validate since {0} is not a valid Livecode executable. Use the setting \'livecodescript.validate.executablePath\' to configure the Livecode executable.', executable);
+				message = localize('wrongExecutable', 'Cannot validate since {0} is not a valid Livecode executable. Use the setting \'livecodescript.LivecodeServerExecutablePath\' to configure the Livecode executable.', executable);
 			} else {
-				message = localize('noExecutable', 'Cannot validate since no Livecode executable is set. Use the setting \'livecodescript.validate.executablePath\' to configure the Livecode executable.');
+				message = localize('noExecutable', 'Cannot validate since no Livecode executable is set. Use the setting \'livecodescript.LivecodeServerExecutablePath\' to configure the Livecode executable.');
 			}
 		} else {
 			message = error.message ? error.message : localize('unknownReason', 'Failed to run Livecode using path: {0}. Reason is unknown.', executable);
@@ -269,7 +269,7 @@ export default class LivecodescriptValidationProvider {
 	private async showErrorMessage(message: string): Promise<void> {
 		const openSettings = localize('goToSetting', 'Open Settings');
 		if (await vscode.window.showInformationMessage(message, openSettings) === openSettings) {
-			vscode.commands.executeCommand('workbench.action.openSettings', Setting.ExecutablePath);
+			vscode.commands.executeCommand('workbench.action.openSettings', Setting.LivecodeServerExecutablePath);
 		}
 	}
 }
@@ -285,7 +285,7 @@ async function getConfig(): Promise<ILivecodescriptConfig> {
 
 	let executable: string | undefined;
 	let executableIsUserDefined: boolean | undefined;
-	const inspect = section.inspect<string>(Setting.ExecutablePath);
+	const inspect = section.inspect<string>(Setting.LivecodeServerExecutablePath);
 	if (inspect && inspect.workspaceValue) {
 		executable = inspect.workspaceValue;
 		executableIsUserDefined = false;