• Stars
    star
    179
  • Rank 214,039 (Top 5 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 9 years ago
  • Updated about 7 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Make your Ember App Stylish

Ember Suave Build Status

This library is based on JSCS linting rules and is no longer maintained. For the ESLint equivalent, see eslint-plugin-ember-suave.

Ensures super stylish code by enforcing the DockYard JavaScript and Ember style guide rules.

suave

ESLint Installation and Usage

If you are using ember-cli-eslint in your project, and you would like to also make use of all the ember-suave rules, we have great news! We have created eslint-plugin-ember-suave, which allows you to extend the recommended suave rules, right in your .eslintrc.js. Further instructions on usage and configuration can be found on the eslint-plugin-ember-suave repo.

JSCS Installation

ember install ember-suave

Post installation, you will find a .jscsrc file at the root of your project, with the following content:

{
  "preset": "ember-suave"
}

This sets ember-suave as the default JSCS preset.

JSCS Usage

ember-suave integrates well with ember-cli, but can also be used as a standalone JSCS preset. This allows custom editor integration, and non-Ember CLI projects to utilize our curated set of rules.

When used from within ember-cli, your test suite will automatically fail if any of the rules are broken.

JSCS Rules

Default Rules

ember-suave comes preconfigured with DockYard-curated JSCS rules so that all you need to do is install the addon and start writing stylish code.

Customization

If ember-suave isn't suave enough for you and you'd like to override certain rules, simply add your own rules to .jscsrc at the root of your Ember CLI project. Those rules will take precedence over the ones in the default preset.

You can specify any of the rules that are built into JSCS, provide your own custom ones, or even override the ones we have enabled by default.

To disable a rule, set its value to null or false.

{
  "preset": "ember-suave",
  "additionalRules": ["./lib/rules/*.js"],
  "myAwesomeCustomRule": true,
  "disallowDanglingUnderscores": true,
  "disallowEmptyBlocks": null
}

Development

  • git clone this repository
  • npm install

Running Tests

  • npm test

Versioning

Bug fixes will be released as minor or patch version bumps. In some limited cases, a bugfix might cause a previously ignored file or section to be parsed and trigger a failed test, but this is fairly unlikely.

Changing the preset in any way that causes previously passing tests to fail would require a major version bump. This will lead to a larger number of major version releases than a typical project, but provides consumers with relative safety in the use of ^X.Y.Z style version ranges.

Legal

DockYard, Inc © 2016

@dockyard

Licensed under the MIT license

More Repositories

1

client_side_validations

Client Side Validations made easy for Ruby on Rails
Ruby
2,686
star
2

ember-validations

Validations for Ember Objects
JavaScript
832
star
3

postgres_ext

Adds support for missing PostgreSQL data types to ActiveRecord
Ruby
643
star
4

ember-easy-form

Easily build semantic forms in Ember
JavaScript
565
star
5

party_foul

Use GitHub to track your application errors!
Ruby
517
star
6

ruby-destroyed_at

ActiveRecord Mixin for Safe Destroys
Ruby
349
star
7

capybara-email

Test your ActionMailer and Mailer messages with Capybara
Ruby
339
star
8

postgres_ext-serializers

Ruby
324
star
9

client_side_validations-simple_form

Simple Form plugin for ClientSideValidations
JavaScript
254
star
10

ember-appkit-rails

Ember Appkit for Rails
Ruby
238
star
11

ember-one-way-controls

Native one way input
JavaScript
176
star
12

ember-data-route

Common teardown scenario for ember routes backed by a data model
JavaScript
120
star
13

ember-cli-i18n

Simple Internationalization support for ember-cli apps
JavaScript
112
star
14

dismissible_helpers

Ruby
96
star
15

es6_module_transpiler-rails

Transpile ES6 Modules in the Rails Asset Pipeline
JavaScript
87
star
16

capybara-extensions

Complements Capybara with additional finders and matchers.
Ruby
66
star
17

ruby-context_validations

Context Aware Validations for Rails
Ruby
65
star
18

pg_array_parser

Ruby
61
star
19

pages

Easy pages in Rails
Ruby
49
star
20

ember-skeleton

Show fast-loading temporary images in place of an eventual slow-loading image
JavaScript
41
star
21

ember-cli-proxy-fixtures

Ember CLI Proxy Fixtures
JavaScript
38
star
22

client_side_validations-mongoid

Mongoid plugin for ClientSideValidations
Ruby
28
star
23

ruby-easy_auth

Dead simple drop-in identity based Rails authentication
Ruby
28
star
24

ember-admin-bootstrap

Ember Admin with a Twitter Bootstrap Theme
CSS
25
star
25

client_side_validations-formtastic

Formtastic plugin for ClientSideValidations
Ruby
18
star
26

ember-wuphf

JavaScript
17
star
27

postgres_ext-postgis

Ruby
14
star
28

ember-cli-one-script

This addon combines your `vendor.js` and `<your-app-name>.js` into a single file called `app.js`
JavaScript
14
star
29

client_side_validations-turbolinks

Turbolinks Plugin for ClientSideValidations
Ruby
9
star
30

fixtory

Not quite fixtures, not quite factories
Ruby
9
star
31

ember-new-modules-shim

JavaScript
6
star
32

client_side_validations-backbone

Backbone plugin for ClientSideValidations
JavaScript
6
star
33

ember-cli-test-interactions

Ember acceptance test helpers.
JavaScript
3
star
34

minitest-moar

Moar Minitest Pluzsh!
Ruby
3
star
35

ruby-easy_auth-password

Password plugin for EasyAuth
Ruby
3
star
36

mail_congress

Ruby
2
star
37

ruby-easy_auth-oauth2

Ruby
1
star
38

ruby-easy_auth-twitter

Ruby
1
star
39

ruby-easy_auth-linked_in

Ruby
1
star
40

comet

Elixir
1
star