Fix package manager installation for v1.0.8-3 (#62)

* feat: added install script and updated docs

* docs: fixups to README

* docs: added edit_command_buffer to README.md

* fix: `fish-lsp info` logsfile location & readme wording

* fix: `package.json` removed linking, reworded setup section `README.md`

* fix: `package.json` pkg config

* fix: audit `yarn.lock` removed deprecated `cross-spawn`

* fix: removed unused fish-lsp enviornment variables w/ README changes

- removed `fish_lsp_format_tabsize` & `fish_lsp_format_switch_case`
- fixed `src/cli.ts` formatting for `fish-lsp info`
- added `fish-lsp complete` completions for `-v/--version`, `-h/--help`,
`--help-*`, when 0 subcommands and/or flags are given

* docs: fixed `README.md` section order

* fix: `yarn pack` and `package.json` scripts appear to be working

- `yarn pack` creates a tarball of the package
- `package.json` scripts are updated to properly build the tarball
- added `files` field to `package.json` to include the directories
  necessary for the package to work *(main features working, but
  more testing is needed)*. See [package.json](./package.json) line 25
  for more details.

---

**What is this commit fixing?**

when a user tries to install the fish-lsp npm package, through their
package manager using something like:

```bash
npm install -g fish-lsp
pnpm install -g fish-lsp
yarn global add fish-lsp
```

The package manager previously needs to use typescript to build the
`src/**` directory, which is not necessary. This branch is testing
various methods of improving the package manager installation
experience.

---

**TODO/Notes**

- if we can get the wasm file to be included in the published
  package, then we can remove most of the `postinstall` related
  workarounds in the `package.json` scripts, which would be nice.

- previous attempts at publishing the `tree-sitter-fish.wasm` file
  have been made. Most noteably, in versions `v1.0.0`, `v1.0.1`, etc...
  the `wasm` file included did not properly bundle a wasm file with
  a correct [magic-number](https://www.google.com/search?client=firefox-b-1-d&q=wasm+magic+number)

- once the `postinstall`/`wasm` issues are resolved, building from
  source will no longer be necessary to install the package.

* fix: conf.d not included in background analysis

- removed yarn.lock
- added files to package.json
- removed .yarnrc.yml
- successfully built on npm, yarn, & pnpm by `pack` testings
- fixed minor misnumbered error code `src/diagnostics/errorCodes.ts`
- removed packageManager key from package.json because of corepack

* fix: rm *.wasm from .gitignore, added wasm to repo

- added yarn.lock back to .gitignore

* fix: added startup time w/ logger + popup support to `src/analyzer.ts`

- changes made to `package.json` scripts
  - `dev` script for local development
  - `dev:watch` script for local development
- `tsconfig.json` now contains a key for building `.tsbuildinfo` file
and `clean` package.json removes it
- `README.md` comments removed + fixes to other minor typo changes

* fix: deps in package.json `typescript version too hight for eslint`

- moved marked-man to `devDependencies`
- typescript now using 5.5.4 in `devDependencies`

* fix: ci.yml and added .npmignore

* fix: added tests to ci.yml and yarn.lock

* fix: fast-glob moved to dependencies

* docs: minor comment to README.md

* feat: fixed `src/execute-handler.ts` for testing

- issue visible in [pr #61](https://github.com/ndonfris/fish-lsp/pull/61/files)

Co-authored-by: branchvincent <[email protected]>

* docs: fix `README.md` Client Configurations (REQUIRED)

* chore: added @branchvincent to `.all-contributorsrc`

Signed-off-by: nick donfris <[email protected]>

* fix: `npm publish` should now work, `docs/MAN_FILE.md` updates, complete changes

- `fish-lsp complete` now outputs completions for `fish-lsp env
--no-global --no-local --no-comments --no-export`
- `fish-lsp info --time-startup` is now a valid operation
- man page was updated
- updated .npmignore & .gitignore
- updated README.md
- added functions to `src/cli.ts` for `--time-startup` operation
- added arguments to functions in `src/config.ts` for `fish-lsp env`
behavior
- pkg behaviour is still not working correctly

* fix: removed tests from `.github/workflows/ci.yaml` because of race condition

* docs: updated `docs/CHANGLOG.md`, `docs/CONTRIBUTING.md` and `README.md`

* docs: updated `docs/CHANGELOG.md` & `package.json` for v1.0.8-3

---------

Signed-off-by: nick donfris <[email protected]>
Co-authored-by: branchvincent <[email protected]>

Author: ndonfris

.all-contributorsrc

@@ -83,6 +83,15 @@
         "content",
         "doc"
       ]
+    },
+    {
+      "login": "branchvincent",
+      "name": "Branch Vincent",
+      "avatar_url": "https://avatars.githubusercontent.com/u/19800529?v=4",
+      "profile": "https://github.com/branchvincent",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/workflows/ci.yml

@@ -16,24 +16,30 @@ jobs:
 
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Fish Shell
         uses: fish-actions/[email protected]
 
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 21.7.1
+          node-version: 22.12.0
 
       - name: Install Yarn
         run: npm install -g [email protected]
 
       - name: Install Dependencies
         run: yarn install
 
+      - name: Build Development
+        run: yarn dev
+
       - name: Check Binary
         run: fish-lsp --help
 
       - name: Run Lint
-        run: yarn lint:fix
+        run: yarn lint:fix
+      
+      # - name: Run Test
+      #   run: yarn test

.gitignore

@@ -5,8 +5,8 @@ node_modules
 *.log
 *.tsbuildinfo
 logs.txt
-*.wasm
 wikis
+build
 test-data/staging
-!snippets/*.json
-snippets/*
+*.tgz
+*.tsbuildinfo

.npmignore

@@ -0,0 +1,32 @@
+.git/
+.github/
+.husky/
+.eslintrc.cjs
+.eslintignore
+.gitignore
+*.tsbuildinfo
+.editorconfig
+.gitattributes
+*.tgz
+
+yarn.lock
+.yarnrc.yml
+.yarnrc
+.nvmrc
+package-lock.json
+pnpm-lock.yaml
+npm-shrinkwrap.json
+
+test-data
+build
+
+tsconfig*.json
+jest.config.js
+commitlint.config.ts
+renovate.json
+
+*.tsbuildinfo
+.editorconfig
+docs/*
+!docs/MAN_FILE.md
+!docs/man/fish-lsp.1

.nvmrc

@@ -1 +1 @@
-v21.7.1
+v22.12.0