Giter VIP home page Giter VIP logo

website's Introduction

Unibeautify

Renovate enabled Maintainability

One Beautifier to rule them all, One Beautifier to clean them, One Beautifier to bring them all and in the darkness sheen them

Travis CI (Linux / macOS) AppVeyor (Windows) Test Coverage
Build Status Build status Test Coverage

Why

  • Single beautifier abstracting multiple beautifiers for multiple languages
  • Unified beautifier configuration options

Install

To use programmatically with Node.js:

$ npm install --save unibeautify

CLI

See Unibeautify-CLI:

$ npm install --global @unibeautify/cli

Usage

See test/ directory for examples.

Contribute

# Be sure to lint
npm run lint
# And build
npm run build
# And test
npm test

website's People

Contributors

dependabot[bot] avatar glavin001 avatar greenkeeper[bot] avatar imgbotapp avatar odahcam avatar renovate-bot avatar renovate[bot] avatar stevenzeck avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

website's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

  • Update dependency @types/lodash to v4.17.4
  • Update dependency fs-extra to v11 (fs-extra, @types/fs-extra)
  • Update dependency node to v20
  • Update dependency prettier to v3
  • Update dependency rimraf to v5
  • Update dependency stylelint to v16
  • Update dependency stylelint-config-standard to v36
  • Update dependency stylelint-order to v6
  • Update dependency tslint to v6
  • Update dependency typescript to v5
  • 🔐 Create all rate-limited PRs at once 🔐

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

docker-compose
docker-compose.yml
dockerfile
Dockerfile
npm
package.json
  • @types/diff 4.0.2
  • @types/fs-extra 8.1.5
  • @types/lodash 4.17.1
  • @unibeautify/beautifier-black 0.1.2
  • @unibeautify/beautifier-brittany 0.0.1
  • @unibeautify/beautifier-clang-format 0.2.0
  • @unibeautify/beautifier-csscomb 0.1.0
  • @unibeautify/beautifier-eslint 0.6.0
  • @unibeautify/beautifier-gofmt 0.1.0
  • @unibeautify/beautifier-js-beautify 0.4.0
  • @unibeautify/beautifier-php-codesniffer 0.1.2
  • @unibeautify/beautifier-php-cs-fixer 0.4.0
  • @unibeautify/beautifier-prettier 0.9.0
  • @unibeautify/beautifier-prettydiff 0.6.0
  • @unibeautify/beautifier-sqlformat 0.0.1
  • @unibeautify/beautifier-stylelint 0.0.1
  • @unibeautify/beautifier-tslint 0.1.0
  • @unibeautify/beautifier-yapf 0.3.0
  • @unibeautify/ugly-samples 0.2.10
  • array-flatten 2.1.2
  • csscomb 4.3.0
  • diff 4.0.2
  • eslint 4.19.1
  • eslint-plugin-react 7.34.1
  • fs-extra 8.1.0
  • get-pkg-repo 4.2.1
  • js-beautify 1.15.1
  • lodash 4.17.21
  • prettier 1.19.1
  • prettydiff2 2.2.8
  • rimraf 3.0.2
  • stylelint 13.13.1
  • ts-node 8.10.2
  • tslint 5.20.1
  • typescript 3.9.10
  • unibeautify 0.17.1
website/package.json
  • bootstrap 4.3.1
  • featherlight 1.7.14
  • jquery 3.4.1
  • docusaurus 1.14.7
  • js-yaml 3.14.1
  • stylelint 11.1.1
  • stylelint-config-standard 19.0.0
  • stylelint-order 3.1.1
nvm
.nvmrc
  • node 12.4.0

  • Check this box to trigger a request for Renovate to run again on this repository

Yarn docs error

When I run yarn install && yarn docs I get this error:

→ yarn docs
yarn run v1.7.0
$ npm run clean && npm run generate-docs

> [email protected] clean /Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website
> npm run rm-languages && npm run rm-beautifiers && npm run rm-options && npm run rm-executables


> [email protected] rm-languages /Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website
> rimraf 'docs/language-*'


> [email protected] rm-beautifiers /Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website
> rimraf 'docs/beautifier-*'


> [email protected] rm-options /Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website
> rimraf 'docs/option-*' && rimraf 'docs/options-for-languages.md'


> [email protected] rm-executables /Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website
> rimraf 'docs/executable-*'


> [email protected] generate-docs /Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website
> ts-node scripts/generate-docs

brace_style - HTML - BAD EXAMPLES
newline_between_rules - CSS - BAD EXAMPLES
Error: Dependency "Black" is required and not installed.
  - spawn black ENOENT
  - spawn black ENOENT
  - spawn black ENOENT
    at loadVersion.then.catch.then.isInstalled (/Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website/node_modules/unibeautify/src/DependencyManager/Dependency.ts:34:17)
    at process._tickCallback (internal/process/next_tick.js:68:7)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] generate-docs: `ts-node scripts/generate-docs`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] generate-docs script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/marvinheilemann/.npm/_logs/2018-07-05T09_35_41_495Z-debug.log
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Node: v10.4.1
Yarn: 1.7.0
on latest OSX (10.13.5)

that results in empty .md doc files (beautifier-black-beautifier.md etc.).

A resulting error is that when I do cd website/ && yarn start and navigate to http://localhost:3000/docs/about.html that I get this browser error:

Error: Improper sidebars.json file, document with id 'beautifier-black' not found. Make sure that documents with the ids specified in sidebars.json exist and that no ids are repeated.
    at _loop (/Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website/website/node_modules/docusaurus/lib/server/readCategories.js:58:17)
    at readCategories (/Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website/website/node_modules/docusaurus/lib/server/readCategories.js:34:53)
    at DocsSidebar.render (/Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website/website/node_modules/docusaurus/lib/core/DocsSidebar.js:18:26)
    at processChild (/Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website/website/node_modules/react-dom/cjs/react-dom-server.node.development.js:2204:18)
    at resolve (/Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website/website/node_modules/react-dom/cjs/react-dom-server.node.development.js:2061:5)
    at ReactDOMServerRenderer.render (/Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website/website/node_modules/react-dom/cjs/react-dom-server.node.development.js:2380:22)
    at ReactDOMServerRenderer.read (/Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website/website/node_modules/react-dom/cjs/react-dom-server.node.development.js:2354:19)
    at renderToStaticMarkup (/Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website/website/node_modules/react-dom/cjs/react-dom-server.node.development.js:2737:25)
    at renderToStaticMarkupWithDoctype (/Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website/website/node_modules/docusaurus/lib/server/renderUtils.js:16:30)
    at /Users/marvinheilemann/Documents/Projects/_plugins/Unibeautify/website/website/node_modules/docusaurus/lib/server/server.js:283:14

Redo options table and list to make clear deprecated options

https://unibeautify.com/docs/options.html and the contents of the left nav https://unibeautify.com/docs/option-align-assignments.html should make clear which options are deprecated.

Table

  1. Remove the option entirely from the table
  2. Add new column(s) to the table for newer metadata
  3. Leave table as-is

Nav

  1. Create a section beneath the "W" on the left named "Deprecated" and list options that are deprecated there instead of under their letter

Improve SEO of website

Keywords

  • open source code beautifier
  • (each of the beautifier names)
  • atom-beautify
  • (language) code formatter
  • code formatter
  • (language) prettier
  • eslint prettier
  • javascript formatter
  • prettier vscode
  • code beautify
  • beautifier code
  • format code
  • js formatter
  • (beautifier) (language)
  • (beautifier) (editor)
  • (beautifier) config

Search intent

What is...

  • what is (beautifier)
  • what is (language)
  • what is (editor)

How to...

  • how to format code with (beautifier)

People also ask

  • How do you use (beautifier)?

  • Should I use (beautifier)?

  • How do you use (beautifier) in (editor)?

  • Does (beautifier) ignore node_modules?

  • Is (beautifier) a linter?

  • How do I enable (beautifier) on save?

  • How do I install (beautifier) globally?

  • How do I change the format code in (editor)?

  • What is code formatting?

  • How do I disable (beautifier) in (editor)?

  • What is (beautifier) used for?

  • (language) formatter (editor)

  • (language) formatter

  • (language) code formatter

  • code formatter online

  • (beautifier) sandbox

  • run (beautifier) on all files

  • (beautifier) vs (beautifier)

  • (editor) beautify shortcut

  • (editor) formatting settings

  • (editor) disable format on save

  • (editor) format on save not working

  • (editor) format shortcut

  • (editor) code format code not working

  • (beautifier) (option) not working

  • (beautifier) not working (editor)

  • beautify code

  • how to use prettier vscode

  • jsbeautifyrc

  • How do you customize (beautifier)?

  • How to install (beautifier) in (editor)?

  • How do I enable/disable (beautifier) in (editor)?

  • How do I use (beautifier) in (editor)?

Links don't work in Firefox

None of the links on the unibeautify site work in Firefox, i.e. clicking doesn't do anything.

Looking in the dev console, it appears that the site is trying to do something fancy with GA, but that's blocked by Firefox.

Screencast_09-18-2020_07 54 51 AM

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

Query for Unibeautify Beautifiers from npm

See https://github.com/npm/public-api/issues/15 for problem.

Logo Design

@szeck87 @CelinaCampbell @muuvmuuv we should discuss the logo situation.

1️⃣Version 1 2️⃣Version 2 3️⃣Proposal
image image image By @muuvmuuv

(I don't know how to fix the logo sizes above 🙄)

I'm not entirely sold on the space theme, with the planet in the 3️⃣proposed logo.

1️⃣ was inspired by the slogan "the one beautifier to rule them all" (a Lord of the Rings reference).
2️⃣ is a a work in progress to create a clearly readable logo, focusing on the U and B (for Uni and Beautify).


@muuvmuuv 's comment:
Hey guys, I played a little bit with the Unibeautify logo on the weekend. I don’t want to offend someone, but it looks a little bit unfinished for me. So here is my idea plus a idea how we could design the website (not mine, its from dribbble).

How we could design the webpage in the future:
image

my idea of the logo
image

I think the logo and design is very important, however it has not been a priority of mine these past few months. I think @muuvmuuv has a good point, we should make the design and logo look finished and polished.

Use prism.js instead of highlight.js to render code samples

Customize edit button for auto-generated docs

Since some of the docs are auto-generated based on beautifiers and Unibeautify loaded languages and options, the edit button linking to the markdown files does not make sense. Instead, it should redirect to the appropriate place to edit.

This will require a change to Docusaurus itself: https://github.com/facebook/Docusaurus/blob/a5e963dba134bf0f6a83908d49cd59ce06704cb3/lib/core/Doc.js#L30-L37

Image size on website

From @bardware on September 7, 2018 13:46

Hi,

I just stumble over your website and see you embed logos of languages that are 400 kByte in size. That's a lot. It looks to me it's a png embedded in svg. Maybe you can resize it.
grafik

Copied from original issue: Unibeautify/unibeautify#178

Individual pages for options

The individual pages for options is getting to be quite large, even with expand/collapse sections. A few thoughts:

  • Consider having just a single example for an option, rather than one for all languages. I see examples as something to just get the point across, and 95% of the time a single one will do that. For instance, indent_style is pretty straightforward. I can look at a Javascript example and probably get the idea of how it would work for HTML.
  • Consolidate all the languages that don't have an example into a comma separated list, with a link going to the GitHub example page for that language/option.

Autogenerate installation instructions for README

Inspired by Unibeautify/vscode#23 and #114

Build something like https://github.com/Unibeautify/vscode/blob/master/scripts/update-readme.ts to generate installation instructions and update the README. Use beautifiers from https://github.com/Unibeautify/website/blob/master/scripts/generate-docs/beautifiers.ts#L12-L22 . This will prevent problems like #114 which are confusing to users who are trying to contribute. Documentation is important!

Please let me know if you would like to work on this! I (@Glavin001) have not started yet and looking for contributors. If you take this on, I can add the in progress label so no one else works on it by accident. Thanks in advance!

Version 10 of node.js has been released

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

  • Added the new Node.js version to your .travis.yml

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

More information on this issue

Greenkeeper has checked the engines key in any package.json file, the .nvmrc file, and the .travis.yml file, if present.

  • engines was only updated if it defined a single version, not a range.
  • .nvmrc was updated to Node.js 10
  • .travis.yml was only changed if there was a root-level node_js that didn’t already include Node.js 10, such as node or lts/*. In this case, the new version was appended to the list. We didn’t touch job or matrix configurations because these tend to be quite specific and complex, and it’s difficult to infer what the intentions were.

For many simpler .travis.yml configurations, this PR should suffice as-is, but depending on what you’re doing it may require additional work or may not be applicable at all. We’re also aware that you may have good reasons to not update to Node.js 10, which is why this was sent as an issue and not a pull request. Feel free to delete it without comment, I’m a humble robot and won’t feel rejected 🤖


FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.