Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/panoply/liquify
💧 WIP ~ Liquid Language Support
https://github.com/panoply/liquify
completion formatting intellisense language-server-protocol liquid lsp-server parser syntax-highlighting vscode vscode-extension
Last synced: 2 months ago
JSON representation
💧 WIP ~ Liquid Language Support
- Host: GitHub
- URL: https://github.com/panoply/liquify
- Owner: panoply
- Created: 2020-01-25T13:19:13.000Z (almost 5 years ago)
- Default Branch: dev
- Last Pushed: 2024-03-17T15:39:14.000Z (10 months ago)
- Last Synced: 2024-10-06T15:36:56.714Z (4 months ago)
- Topics: completion, formatting, intellisense, language-server-protocol, liquid, lsp-server, parser, syntax-highlighting, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://liquify.dev
- Size: 4.61 MB
- Stars: 48
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
💧 WIP
Liquify is still under development. The project has been open sourced and will
release in an incremental manner. You can find various projects the exist as part of
Liquify already in circulation. The containing readme files are not up to date so
please grain of salt content.
→ Join the Discord and collaborate on the project
# Liquify
Liquify provides powerful developer tooling for the [Liquid Template Language](https://shopify.github.io/liquid/).
- [Discord](https://discord.gg/eUNEsxMuWt)
### Why
The Liquid template language has been around for a long time. Created by Shopify CEO [Tobi Lütke](https://twitter.com/tobi) it is leveraged by hundreds of different SaaS services, thousands of open source projects and tends to be the preferred choice for JAM~Stacked (SSG) generated web applications. Despite Liquid being actively maintained by Shopify, their current solutions are missing a lot of key capabilities which I consider necessities.
Liquify was created to solve the issue of lack-lustered and otherwise incompatible solutions which exist within nexus. It intends to provide everything required for Shopify themes, Jekyll and 11ty static sites or custom projects leveraging Liquid as the consumer facing language. It aims to deliver powerful text editor features that enrich the programming experience and lives of those working with the template language.
###### LICENSING
**Package licensing matters! [MIT](https://mit-license.org/), [PROPRIETARY](#) or [CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/) licenses are imposed. Though the code is public, please be aware of the licensing of each package.**
# Packages
Liquify is a [pnpm](https://pnpm.js.org/en/cli/install) powered monorepo project. Most packages contained within this repository are available for download via the NPM Registry. Consult the readme of each package for a deeper understanding of a modules use-case and appropriation. Some packages are maintained in an isolated repositories using [Git Sub-Modules](https://git-scm.com/book/en/v2/Git-Tools-Submodules). PR's and issues pertaining to submodule projects are tracked outside of this repository.
## Client Packages
These packages are the text editor [LSP](https://microsoft.github.io/language-server-protocol/specifications/specification-current/) clients.
- [@liquify/vscode](https://github.com/panoply/liquify/tree/next/packages/vscode)
- [@liquify/sublime](https://github.com/panoply/liquify/tree/next/packages/sublime)
- [@liquify/vim](https://github.com/panoply/liquify/tree/next/packages/vim)
## Core Packages
These packages are considered the _core_ modules of the project.
- [@liquify/parser](https://github.com/panoply/liquify/tree/next/packages/parser)
- [@liquify/specs](https://github.com/panoply/liquify/tree/next/packages/specs)
- [@liquify/schema](https://github.com/panoply/liquify/tree/next/packages/schema)
> The `@liquify/schema` package is published as a sub-module.
## Language Server
- [liquid-language-server](https://github.com/panoply/liquify/tree/next/packages/server)
This is the Language Server module that provide text editor capabilities in vscode and other LSP supported environments.
## Config Packages
These packages are the sharable configurations for popular development tools leveraged in the workspace.
- [@liquify/tsconfig](https://github.com/panoply/liquify/tree/next/utils/tsconfig)
- [@liquify/eslint-config](https://github.com/panoply/liquify/tree/next/utils/eslint-config)
- [@liquify/prettier-config](https://github.com/panoply/liquify/tree/next/utils/prettier-config)
- [@liquify/stylelint-config](https://github.com/panoply/liquify/tree/next/utils/stylelint-config)
## Extended Packages
These are an assortment a different packages which were developed for specific purposes. They are made available as modules for consumption by projects that may wish to use or require them.
- [@liquify/highlight](https://github.com/panoply/liquify/tree/next/packages/highlight)
- [@liquify/papyrus](https://github.com/panoply/liquify/tree/next/packages/prism)
## Testing Package
This is test runner extension package which extends upon [AVA](https://github.com/avajs/ava). The module helps alleviate some of the complexities involved with testing AST structures in projects like [@liquify/parser](https://github.com/panoply/liquify/tree/next/packages/parser), [Æsthetic](https://github.com/panoply/esthetic) and more.
- [@liquify/ava](https://github.com/panoply/liquify/tree/next/packages/ava)
## Submodule Packages
These packages exist in the monorepo but are distributed independent of the Liquify organization NPM registry name. These packages are published and maintained in an isolated repositories using [Git Sub-Modules](https://git-scm.com/book/en/v2/Git-Tools-Submodules).
- [moloko](https://github.com/panoply/liquify/tree/next/packages/moloko)
- [esthetic](https://github.com/panoply/liquify/tree/next/packages/esthetic)
- [papyrus](https://github.com/panoply/liquify/tree/next/packages/papyrus)
- [syncify](https://github.com/panoply/liquify/tree/next/packages/syncify)
# Documentation
Several different projects exist within Liquify. Some projects have their own designated documentation and domain address. Documentation packages are marked as **private** and are served up via [Netlify](https://netlify.com/). Refer to below list of documentation websites shipped from this monorepo.
- [liquify.dev](https://liquify.dev)
- [æsthetic.dev](https://æsthetic.dev)
- [papyrus.js.org](https://papyrus.js.org)
- syncify.js.org
Refer to readme files contained within the **docs** sub-directory of each project for more information.
# Contributing
The project and its containing modules use [pnpm](https://pnpm.js.org/) for dependency and workspace management. Development is intended to be conducted within the [vscode](https://code.visualstudio.com/) text editor. It is important that you install all the recommended extensions and also disable the unwanted extensions. The **recommended** extensions are important as they ensure the best possible development experience.
Pre-requisites
- [Git](https://git-scm.com/)
- [Node v16^](https://nodejs.org/)
- [Pnpm v7^](https://pnpm.js.org/)
- [VSCode](https://code.visualstudio.com/)
Third Parties (optional)
- [Potion Theme](https://marketplace.visualstudio.com/items?itemName=sissel.material-potion)
- [Github Desktop](https://desktop.github.com/)
- [iTerm2](https://iterm2.com/)
> _While not required, if you wish to recreate the environment in which this project is developed then you can install and leverage the above additional third-party tooling._
## Installation
- Ensure [pnpm](https://pnpm.js.org/) is installed globally `npm i pnpm -g`
- Leverage `pnpm env` if you need to align node versions
- Clone this repository `git clone https://github.com/panoply/liquify.git`
- Run `pnpm i` in the root directory
The project will be complied and all packages will build in `postinstall`. You can `cd` into any package or alternatively you can run `pnpm dev` from workspace root to start watch + build mode on packages that are specific to Liquify. The `pnpm dev` when executed from workspace root will target only specific packages relating to Liquify and exclude utils/docs etc.
## Developing
All packages are compiled with [ESBuild](https://esbuild.github.io/) via [tsup](https://tsup.egoist.sh/#usage). In packages which require an additional build step you'll be able to find any additional logic in a containing `scripts` directory. When developing on the Language Server and Language Client you can run `pnpm dev` which will invoke watch and build instances for those core packages and then from here start up the extension host within vscode.
#### Per Package
```
pnpm dev Watch and build modes
pnpm build Build mode only (production)
pnpm test Run tests, the project uses AVA
```
> If you cannot be bothered to `cd` into each package then you can target packages from root directory of the workspace or alternatively just run `pnpm dev` and all core packages will run in watch mode.
#### Recursive (Workspace Root)
```
pnpm dev Watch and build all projects relating to editor capabilities
pnpm build Build production/development bundles (this is a production build)
pnpm test Tests all packages in the repository
```
#### Targeting (Workspace Root)
```
pnpm @server Targets the Liquid Language Server package
pnpm @esthetic Targets the Æsthetic package
pnpm @parser Targets the Liquid Language Parser package
pnpm @specs Targets the Liquid Language Specs package
pnpm @vscode Targets the vscode client package
pnpm @moloko Targets the Moloko (monaco) text editor package
pnpm @highlight Targets the CLI syntax highlight package
pnpm @ava Targets the AVA test extender package
pnpm @schema Targets the Schema Stores package
```
#### Documentation (Workspace Root)
```
pnpm @docs:liquify Targets the liquify.dev documentation
pnpm @docs:esthetic Targets the æsthetic.dev documentation
pnpm @docs:moloko Targets the moloko.js.org documentation
pnpm @docs:syncify Targets the syncify.js.org documentation
pnpm @docs:papyrus Targets the papyrus.js.org documentation
```
## Testing
Package testing is somewhat incomplete. The Liquify project uses [AVA](https://github.com/avajs/ava) for tests and also for printing stdout responses to the CLI in modules like the [@liquify/parser](https://github.com/panoply/liquify/tree/next/packages/parser) and [Æsthetic](https://github.com/panoply/esthetic).
## Contributors
Want to contribute? Shoot me an [email](mailto:[email protected]) or reach out via [Twitter](https://twitter.com/niksavvidis).