Skip to content

Docs: Agregando documentacion con instrucciones de instalacion y uso … #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aldogonzalez2006 wants to merge 1 commit into
base: vs-code-lsp
Choose a base branch
from
Open

Docs: Agregando documentacion con instrucciones de instalacion y uso … #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 43 additions & 46 deletions vscode/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,71 +1,68 @@
# hare-ls README
# Hare Language Server — Extensión de VSCode

This is the README for your extension "hare-ls". After writing up a brief description, we recommend including the following sections.
Esta carpeta contiene la extensión de Visual Studio Code para brindar soporte
de desarrollo al lenguaje de programación Hare, conectándose con el servidor
de lenguaje `harels`.

## Features

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.

For example if there is an image subfolder under your extension project workspace:
---

\!\[feature X\]\(images/feature-x.png\)
## Requisitos Previos

> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
Antes de instalar y ejecutar la extensión, asegúrate de tener instalado en tu sistema:

## Requirements
* [Node.js](https://nodejs.org/es/download/current) versión 18 o superior recomendada -> para distribuidor del usuario -> usando nvm -> con npm.

If you have any requirements or dependencies, add a section describing those and how to install and configure them.
* Verificar version de Node.js node -v

## Extension Settings
* Verificar version de npm npm -v

Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
---

For example:
## Instalación de Dependencias

This extension contributes the following settings:
La extensión tiene su propio `package.json` dentro de la carpeta `vscode/`.
Instala las dependencias **desde esta carpeta**, no desde la raíz del repositorio:

* `myExtension.enable`: Enable/disable this extension.
* `myExtension.thing`: Set to `blah` to do something.
```bash
cd vscode
npm install
```

## Known Issues
> Las advertencias `npm warn deprecated` son normales y no afectan el funcionamiento.

Calling out known issues can help limit users opening duplicate issues against your extension.
---

## Release Notes
## Desarrollo y Pruebas Locales

Users appreciate release notes as you update your extension.
1. Abre la carpeta `vscode` en Visual Studio Code.
2. Genera los archivos de salida de TypeScript necesarios para la compilación:

### 1.0.0
```bash
npx tsc -b client/tsconfig.json
```

Initial release of ...
> Este paso es necesario la primera vez que se clona el repositorio, ya que
> el directorio `client/out/` no existe hasta que se ejecuta este comando.

### 1.0.1
3. Compila el proyecto:

Fixed issue #.
```bash
npm run compile
```

### 1.1.0
> Al finalizar correctamente verás: `Build successful! Binary created at: bin/harels-server`

Added features X, Y, and Z.
4. Abre el archivo `client/src/extension.ts` en VSCode.
5. Listo para ejecutar con F5 o a Run -> Start Debugging para abrir una ventana nueva
de VSCode con la extensión cargada.
6. Abre cualquier archivo `.hare` en esa ventana para verificar que el servidor
de lenguaje esté activo.

---

## Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)

## Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.

## For more information

* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
## Scripts Disponibles

**Enjoy!**
| Script | Descripción |
| `npm run compile` | Ejecuta el chequeo de tipos, el linter, compila con esbuild y corre `./server/build.sh` |
| `npm run watch` | Modo desarrollo: recompila automáticamente al detectar cambios en el código TypeScript|
| `npm run lint` | Revisa la calidad y formato del código fuente |---|---|