From 602751aabb9dc5d015a347721c5fe0c1413e5060 Mon Sep 17 00:00:00 2001 From: Brian McGee Date: Fri, 3 May 2024 16:30:24 +0100 Subject: [PATCH] fix: rename treefmt.go to treefmt-go Signed-off-by: Brian McGee --- .github/settings.yml | 4 ++-- README.md | 12 ++++++------ docs/.vitepress/config.mts | 6 +++--- docs/contributing.md | 4 ++-- docs/installation.md | 2 +- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/settings.yml b/.github/settings.yml index 4f3adda..a0ae796 100644 --- a/.github/settings.yml +++ b/.github/settings.yml @@ -2,13 +2,13 @@ repository: # See https://developer.github.com/v3/repos/#edit for all available settings. # The name of the repository. Changing this will rename the repository - name: treefmt.go + name: treefmt-go # A short description of the repository that will show up on GitHub description: one CLI to format your repo # A URL with more information about the repository - homepage: "https://numtide.github.io/treefmt.go/" + homepage: "https://numtide.github.io/treefmt-go/" # A comma-separated list of topics to set on the repository topics: "cli, formatter, unifies" diff --git a/README.md b/README.md index 75b46a0..ce3d336 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ To reformat the whole source tree, just type `treefmt` in any folder. This is a ## Installation -You can install `treefmt` by downloading the binary. Find the binaries for different architectures [here](https://github.com/numtide/treefmt.go/releases). +You can install `treefmt` by downloading the binary. Find the binaries for different architectures [here](https://github.com/numtide/treefmt-go/releases). Otherwise, you can install the package from source code — either with [Go], or with the help of [nix]. We describe the installation process in detail in the [docs]. @@ -76,7 +76,7 @@ To explore the tool’s flags and options, type: $ treefmt --help ``` -Additionally, there's a wrapper called [`treefmt-nix`](https://github.com/numtide/treefmt.go-nix) for using `treefmt` with [`nix`](https://github.com/NixOS/nix). +Additionally, there's a wrapper called [`treefmt-nix`](https://github.com/numtide/treefmt-go-nix) for using `treefmt` with [`nix`](https://github.com/NixOS/nix). ## Configuration @@ -108,12 +108,12 @@ Before specifying the formatter in the config, make sure it’s installed. To find and share existing formatter recipes, take a look at the [docs]. -If you are a Nix user, you might also be interested in [treefmt-nix](https://github.com/numtide/treefmt.go-nix) to use Nix to configure and bring in +If you are a Nix user, you might also be interested in [treefmt-nix](https://github.com/numtide/treefmt-go-nix) to use Nix to configure and bring in formatters. ## Compatibility -`treefmt` works with any formatter that adheres to the [following specification](https://github.com/numtide/treefmt.go/blob/main/docs/formatters-spec.md). +`treefmt` works with any formatter that adheres to the [following specification](https://github.com/numtide/treefmt-go/blob/main/docs/formatters-spec.md). For instance, you can go for: @@ -121,7 +121,7 @@ For instance, you can go for: - gofmt for Golang - Prettier for JavaScript/HTML/CSS -Find the full list of supported formatters [here](https://numtide.github.io/treefmt.go/formatters). +Find the full list of supported formatters [here](https://numtide.github.io/treefmt-go/formatters). ## Upcoming features @@ -183,7 +183,7 @@ Unless explicitly stated otherwise, any contribution intentionally submitted for [Rust]: https://www.rust-lang.org/ [Go]: https://go.dev/ [Toml]: https://toml.io/en/ -[docs]: https://numtide.github.io/treefmt.go/ +[docs]: https://numtide.github.io/treefmt-go/ [nix]: https://github.com/NixOS/nix [nixpkgs-fmt]: https://github.com/nix-community/nixpkgs-fmt [clang-format]: https://clang.llvm.org/docs/ClangFormat.html diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 014e8d9..321babc 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -2,7 +2,7 @@ import { defineConfig } from 'vitepress' // https://vitepress.dev/reference/site-config export default defineConfig({ - base: '/treefmt.go/', + base: '/treefmt-go/', title: "Treefmt", description: "one CLI to format your repo", @@ -32,11 +32,11 @@ export default defineConfig({ ], socialLinks: [ - { icon: 'github', link: 'https://https://github.com/numtide/treefmt.go' } + { icon: 'github', link: 'https://https://github.com/numtide/treefmt-go' } ], footer: { - message: 'Released under the MIT License.', + message: 'Released under the MIT License.', copyright: "Copyright © 2024-present Treefmt Contributors" } } diff --git a/docs/contributing.md b/docs/contributing.md index b0b3c3b..642b067 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -12,14 +12,14 @@ The `treefmt` binaries and this user guide are licensed under the [MIT license]( ## Before you contribute -Here you can take a look at the [existing issues](https://github.com/numtide/treefmt.go/issues). Feel free to contribute, but make sure you have a +Here you can take a look at the [existing issues](https://github.com/numtide/treefmt-go/issues). Feel free to contribute, but make sure you have a [GitHub account](https://github.com/join) first :slightly_smiling_face:. If you're new to open source, please read GitHub's guide on [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/). It's a quick read, and it's a great way to introduce yourself to how things work behind the scenes in open-source projects. Before sending a pull request, make sure that you've read all the guidelines. If you don't understand something, please -[state your question clearly in an issue](https://github.com/numtide/treefmt.go/issues/new) or ask the community on the [treefmt matrix server](https://matrix.to/#/#treefmt:numtide.com). +[state your question clearly in an issue](https://github.com/numtide/treefmt-go/issues/new) or ask the community on the [treefmt matrix server](https://matrix.to/#/#treefmt:numtide.com). ## Creating an issue diff --git a/docs/installation.md b/docs/installation.md index 8c0c739..a345a97 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -11,7 +11,7 @@ There are two options to install `treefmt`: ## Installing with a binary file -You can find the list of the latest binaries [here](https://github.com/numtide/treefmt.go/releases). +You can find the list of the latest binaries [here](https://github.com/numtide/treefmt-go/releases). ## Building from source