Skip to content
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.

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

Rename the editor folder to editors #1374

Merged
merged 1 commit into from Jun 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 9 additions & 9 deletions .github/workflows/nightly_snapshot.yaml
Expand Up @@ -202,39 +202,39 @@ jobs:
- uses: actions/download-artifact@v2
with:
name: vscode-lsp-binary-x86_64-unknown-linux-gnu
path: editor/vscode/bin
path: editors/vscode/bin
- uses: actions/download-artifact@v2
with:
name: vscode-lsp-binary-x86_64-pc-windows-gnu
path: editor/vscode/bin
path: editors/vscode/bin
- uses: actions/download-artifact@v2
with:
name: vscode-lsp-binary-darwin
path: editor/vscode/bin
path: editors/vscode/bin
- uses: actions/download-artifact@v2
with:
name: vscode-lsp-binary-armv7-unknown-linux-gnueabihf
path: editor/vscode/bin
path: editors/vscode/bin
- uses: actions/download-artifact@v2
with:
name: vscode-lsp-binary-aarch64-unknown-linux-gnu
path: editor/vscode/bin
path: editors/vscode/bin
- name: Fix permissions
run: chmod 755 editor/vscode/bin/* editor/vscode/bin/*.app/Contents/MacOS/*
run: chmod 755 editors/vscode/bin/* editors/vscode/bin/*.app/Contents/MacOS/*
- name: Setup Node.js
uses: actions/setup-node@v1
with:
node-version: '12'
- name: "Prepare meta-data files for nightly package"
env:
RELEASE_INPUT: ${{ github.event.inputs.release }}
working-directory: editor/vscode
working-directory: editors/vscode
run: |
if [ "$RELEASE_INPUT" != "true" ]; then
../../scripts/prepare_vscode_nightly.sh
fi
- name: "npm install"
working-directory: editor/vscode
working-directory: editors/vscode
run: npm install
- name: Install wasm-pack
run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
Expand All @@ -245,7 +245,7 @@ jobs:
pat: ${{ secrets.VSCODE_MARKETPLACE_PAT }}
registryUrl: https://marketplace.visualstudio.com
dryRun: ${{ github.event.inputs.private == 'true' || github.ref != 'refs/heads/master' }}
packagePath: editor/vscode
packagePath: editors/vscode
- name: Publish to Open VSX Registry
continue-on-error: true
if: ${{ github.event.inputs.private != 'true' && github.ref == 'refs/heads/master' }}
Expand Down
8 changes: 4 additions & 4 deletions .reuse/dep5
Expand Up @@ -11,7 +11,7 @@ Files: .clang-format .gitattributes .gitignore */.gitignore .pre-commit-config.y
Copyright: Copyright © SixtyFPS GmbH <info@slint-ui.com>
License: GPL-3.0-only OR LicenseRef-Slint-commercial

Files: CHANGELOG.md CONTRIBUTING.md FAQ.md README.md internal/*/README.md editor/README.md internal/*/CHANGELOG.md api/*/README.md api/*/README.md tools/*/README.md tools/*/CHANGELOG.md
Files: CHANGELOG.md CONTRIBUTING.md FAQ.md README.md internal/*/README.md editors/README.md internal/*/CHANGELOG.md api/*/README.md api/*/README.md tools/*/README.md tools/*/CHANGELOG.md
Copyright: Copyright © SixtyFPS GmbH <info@slint-ui.com>
License: GPL-3.0-only OR LicenseRef-Slint-commercial

Expand Down Expand Up @@ -47,18 +47,18 @@ Files: internal/backends/qt/QtThirdPartySoftware_Listing.txt
Copyright: The Qt Company <https://qt.io/>
License: LGPL-3.0-only

Files: editor/sublime/LSP.sublime-settings
Files: editors/sublime/LSP.sublime-settings
Copyright: Copyright © SixtyFPS GmbH <info@slint-ui.com>
License: GPL-3.0-only OR LicenseRef-Slint-commercial

Files: editor/tree-sitter-slint/binding.gyp editor/tree-sitter-slint/CONTRIBUTING.md
Files: editors/tree-sitter-slint/binding.gyp editors/tree-sitter-slint/CONTRIBUTING.md
Copyright: Copyright © SixtyFPS GmbH <info@slint-ui.com>
License: GPL-3.0-only OR LicenseRef-Slint-commercial

Files: tools/online_editor/*.html tools/online_editor/*.json
Copyright: Copyright © SixtyFPS GmbH <info@slint-ui.com>
License: GPL-3.0-only OR LicenseRef-Slint-commercial

Files: editor/vscode/*.json editor/vscode/README.md
Files: editors/vscode/*.json editors/vscode/README.md
Copyright: Copyright © SixtyFPS GmbH <info@slint-ui.com>
License: GPL-3.0-only OR LicenseRef-Slint-commercial
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -34,7 +34,7 @@ Slint is in active development. Its state of development depends on the kind of
(running on an Arm processor with Linux).
- **Microcontrollers**: *Partial*. [We have ported Slint](https://slint-ui.com/blog/porting-slint-to-microcontrollers.html)
to a couple of MCUs. We are still working on a public API for the platform adaptation layer.
Contact us to get your board supported.
Contact us to get your board supported.
- **Desktop**: *In Progress*. Slint is usable on Windows, Linux and Mac. We plan on building
up the desktop support in subsequent releases to reach the level of integration we're aiming for.
- **Mobile** (Android/iOS): *Todo*. We haven't started supporting mobile platforms yet, but it
Expand Down Expand Up @@ -139,14 +139,14 @@ Rendering backends and styles are configurable at compile time. Current there ar

We have a few tools to help with the development of .slint files:
- A [**LSP Server**](./tools/lsp) that adds features like auto-complete and live preview of the .slint files to many editors.
- It is bundled in a [**Visual Studio Code Extension**](./editor/vscode) available from the market place.
- It is bundled in a [**Visual Studio Code Extension**](./editors/vscode) available from the market place.
- A [**slint-viewer**](./tools/viewer) tool which displays the .slint files. The `--auto-reload` argument makes it easy to preview
your UI while you are working on it (when using the LSP preview is not possible).
- An [**online editor**](https://slint-ui.com/editor) to try out .slint syntax without installing anything ([sources](./tools/online_editor)).
- An [**updater**](./tools/syntax_updater) to convert the .slint files from previous versions to newer versions.
- An experimental [**Figma importer**](./tools/figma_import).

Please check our [Editor README](./editor/README.md) for tips on how to configure your favorite editor to work well with Slint.
Please check our [Editors README](./editors/README.md) for tips on how to configure your favorite editor to work well with Slint.

## Made with Slint

Expand Down
12 changes: 6 additions & 6 deletions editor/README.md → editors/README.md
@@ -1,9 +1,9 @@
# Editor Configuration for Slint

This folder contains extensions or configuration files for different editor to better support .slint files.
This README contains information on how to configure various editors.
This README contains information on how to configure various editors.

If your favorite editor is not in this list, it just means we did not test it, not that it doesn't work.
If your favorite editor is not in this list, it just means we did not test it, not that it doesn't work.
We do provide a [language server for Slint](../tools/lsp) that should work with most editor that supports
the Language Server Protocol (LSP)
(see its [README.md](../tools/lsp/README.md) for more info on how to install it).
Expand All @@ -27,7 +27,7 @@ On Linux, this can be done by running this command

```
mkdir -p ~/.local/share/org.kde.syntax-highlighting/syntax/
wget https://raw.githubusercontent.com/slint-ui/slint/master/editor/kate/slint.ksyntaxhighlighter.xml -O ~/.local/share/org.kde.syntax-highlighting/syntax/slint.xml
wget https://raw.githubusercontent.com/slint-ui/slint/master/editors/kate/slint.ksyntaxhighlighter.xml -O ~/.local/share/org.kde.syntax-highlighting/syntax/slint.xml
```

On Windows, download [slint.ksyntaxhighlighter.xml](./slint.ksyntaxhighlighter.xml) into `%USERPROFILE%\AppData\Local\org.kde.syntax-highlighting\syntax`
Expand Down Expand Up @@ -150,10 +150,10 @@ To setup the LSP:
2. Using Package Control in Sublime Text, install the LSP package (sublimelsp/LSP)
3. Download the Slint syntax highlighting files into your User Package folder,
e.g. on macOS `~/Library/Application Support/Sublime Text/Packages/User/` :
https://raw.githubusercontent.com/slint-ui/slint/master/editor/sublime/Slint.sublime-syntax
https://raw.githubusercontent.com/slint-ui/slint/master/editor/sublime/Slint.tmPreferences
https://raw.githubusercontent.com/slint-ui/slint/master/editors/sublime/Slint.sublime-syntax
https://raw.githubusercontent.com/slint-ui/slint/master/editors/sublime/Slint.tmPreferences
4. Download the LSP package settings file into your User Package folder:
https://raw.githubusercontent.com/slint-ui/slint/master/editor/sublime/LSP.sublime-settings
https://raw.githubusercontent.com/slint-ui/slint/master/editors/sublime/LSP.sublime-settings
5. Modify the slint-lsp command path in `LSP.sublime-settings` to point to the cargo instalation path in your home folder (**Replace YOUR_USER by your username**):
`"command": ["/home/YOUR_USER/.cargo/bin/slint-lsp"]`
6. Run "LSP: Enable Language Server Globally" or "LSP: Enable Lanuage Server in Project" from Sublime's Command Palette to allow the server to start.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions editor/vscode/README.md → editors/vscode/README.md
Expand Up @@ -41,7 +41,7 @@ cargo build --bin slint-lsp
2. run npm install in the vscode directory

```sh
cd editor/vscode
cd editors/vscode
npm install
```

Expand All @@ -55,7 +55,7 @@ You can see the output in the output pane "Slint LSP" (that's the drop-down that
Alternatively, you can start vscode with the following options:

```sh
cd editor/vscode
cd editors/vscode
code --extensionDevelopmentPath=$PWD ../..
```

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion scripts/prepare_vscode_nightly.sh
Expand Up @@ -2,7 +2,7 @@
# Copyright © SixtyFPS GmbH <info@slint-ui.com>
# SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-commercial

cd `dirname $0`/../editor/vscode
cd `dirname $0`/../editors/vscode

modified_files="README.md package.json"

Expand Down
2 changes: 1 addition & 1 deletion tools/lsp/README.md
Expand Up @@ -36,4 +36,4 @@ As the next step, configure your editor to use the binary, no arguments are requ

# Editor configuration

Please check the [editor folder](../../editor/README.md) in the Slint repository for instructions on how to set up different editors to work with Slint.
Please check the [editors folder](../../editors/README.md) in the Slint repository for instructions on how to set up different editors to work with Slint.
4 changes: 2 additions & 2 deletions xtask/src/license_headers_check.rs
Expand Up @@ -263,8 +263,8 @@ enum LicenseLocation {
lazy_static! {
// cspell:disable
static ref LICENSE_LOCATION_FOR_FILE: Vec<(regex::Regex, LicenseLocation)> = [
("^editor/tree-sitter-slint/binding.gyp$", LicenseLocation::NoLicense), // liberal license
("^editor/tree-sitter-slint/queries/.*", LicenseLocation::NoLicense), // liberal license
("^editors/tree-sitter-slint/binding.gyp$", LicenseLocation::NoLicense), // liberal license
("^editors/tree-sitter-slint/queries/.*", LicenseLocation::NoLicense), // liberal license
("^helper_crates/const-field-offset/.*", LicenseLocation::NoLicense), // liberal license
("^helper_crates/document-features/.*", LicenseLocation::NoLicense), // liberal license
(".+webpack\\..+\\.js$", LicenseLocation::NoLicense),
Expand Down