Glavin001/atom-beautify

Feat Request: Config filetypes like .Yaml, .Toml and .HCL

Open

#1.678 geöffnet am 24. Mai 2017

Auf GitHub ansehen
 (5 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)CoffeeScript (1.503 Stars) (442 Forks)batch import
add-beautifieradd-languagegood first issuehelp wanted

Beschreibung

Description

Would be nice to have support added, the structure itself is very similar to Json, but tabbing is used to nest instead of moustache trees.

A sample of Yaml

# Docker Compose file for running a Ruby on Rails app
version: '2'
services:
  db:
    image: postgres
  web:
    build: .
    command: bundle exec rails s -p 3000 -b '0.0.0.0'
    volumes:
      - .:/myapp
    ports:
      - "3000:3000"
    depends_on:
      - db

A sample of Toml

baseurl = "http://yoursite.example.com/"
builddrafts = false
canonifyurls = true

[taxonomies]
  category = "categories"
  tag = "tags"

[params]
  description = "Tesla's Awesome Hugo Site"
  author = "Nikola Tesla"

a sample of HCL

resource "aws_security_group" "ssh" {
    name        = "ssh"
    description = "Allow all inbound SSH traffic"

    ingress {
        from_port   = 22
        to_port     = 22
        protocol    = "tcp"
        cidr_blocks = ["0.0.0.0/0"]
    }
}

Checklist

I have:

Contributor Guide

Tech Stack
javascript
Domain
frontendtooling
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Familiarity with Atom package developmentBasic knowledge of CoffeeScript or JavaScriptUnderstanding of parsing and formatting
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
55
Research-Richtung
This issue requests adding support for YAML, TOML, and HCL file types to Atom Beautify. To implement, first study the existing beautifiers (e.g., for JSON) to understand how languages are registered and processed. Then identify appropriate parsing libraries for each format in Node.js: 'js yaml' for YAML, 'toml' or 'toml js' for TOML, and 'hcl' npm package for HCL. Examine how Atom Beautify handles language detection and config options, and follow the pattern to add new languages. Finally, test with sample files and ensure integration with the Atom editor.