103 Branches 0 Tags

Name	Name	Last commit message	Last commit date
Latest commit renovate[bot] Update dependency ts-node to v10 Apr 9, 2024 9cb4e2f · Apr 9, 2024 History 814 Commits
.vscode	.vscode	Added eslint/stylelint integration	Jul 13, 2018
docs	docs	Close #279 . Track successful GitHub App setup/installation	Sep 13, 2020
scripts	scripts	Close #279 . Track successful GitHub App setup/installation	Sep 13, 2020
website	website	Update dependency docusaurus to v1.14.7	Mar 10, 2021
.dockerignore	.dockerignore	Setup Docker image build process based off Netlify	Jun 27, 2018
.gitignore	.gitignore	Add contributing examples doc	Sep 15, 2018
.nvmrc	.nvmrc	Add stylelint beautifier	Apr 25, 2020
.travis.yml	.travis.yml	Add Travis CI check for README being updated	Sep 15, 2018
.unibeautifyrc.yml	.unibeautifyrc.yml	ADD/Changed the CSS beautifier order	Aug 29, 2018
Dockerfile	Dockerfile	Set netlify/build image tag to be the same as Netlify service itself	Apr 25, 2020
LICENSE	LICENSE	Initial commit	Aug 28, 2016
README.md	README.md	Add Brittany beautifier for Haskell language	Apr 29, 2020
docker-compose.yml	docker-compose.yml	Setup Docker image build process based off Netlify	Jun 27, 2018
package.json	package.json	Update dependency ts-node to v10	Apr 9, 2024
renovate.json	renovate.json	Set Renovate automerge type to branch	Sep 23, 2018
runtime.txt	runtime.txt	Improve Docker image building and Travis CI config	Jun 27, 2018
tsconfig.json	tsconfig.json	Update dependencies	Jun 22, 2018
yarn.lock	yarn.lock	Update dependency ts-node to v10	Apr 9, 2024

Repository files navigation

Unibeautify Website

See https://github.com/Unibeautify/website/blob/master/scripts/beautifiers.ts for list of supported beautifiers. Beautifiers marked with ⚠️ require additional manual installation.

#	Beautifier	Preinstalled	Documentation
1	Black	⚠️	https://unibeautify.com/docs/beautifier-black
2	Brittany	⚠️	https://unibeautify.com/docs/beautifier-brittany
3	CSScomb	✅	https://unibeautify.com/docs/beautifier-csscomb
4	ClangFormat	⚠️	https://unibeautify.com/docs/beautifier-clangformat
5	ESLint	✅	https://unibeautify.com/docs/beautifier-eslint
6	Gofmt	⚠️	https://unibeautify.com/docs/beautifier-gofmt
7	JS-Beautify	✅	https://unibeautify.com/docs/beautifier-js-beautify
8	PHP-CS-Fixer	⚠️	https://unibeautify.com/docs/beautifier-php-cs-fixer
9	PHP_CodeSniffer	⚠️	https://unibeautify.com/docs/beautifier-php_codesniffer
10	Prettier	✅	https://unibeautify.com/docs/beautifier-prettier
11	Pretty Diff	✅	https://unibeautify.com/docs/beautifier-pretty-diff
12	TSLint	✅	https://unibeautify.com/docs/beautifier-tslint
13	YAPF	⚠️	https://unibeautify.com/docs/beautifier-yapf
14	sqlformat	⚠️	https://unibeautify.com/docs/beautifier-sqlformat
15	stylelint	✅	https://unibeautify.com/docs/beautifier-stylelint

Install dependencies:

# For scripts
yarn install

# For Docusaurus
cd website
yarn install

See the documentation of any supported beautifier above marked with ⚠️ and install their prerequisites.

Generate the docs for options, languages, and beautifiers:

yarn docs

We use Docusaurus to build the website:

cd website
yarn start
# navigate to http://localhost:3000

The website is deployed using Netlify. You can edit the Netlify build command in scripts/netlify.sh and then test by building Netlify's Docker image using Docker Compose:

docker-compose build