apiaryio / attributes-kit Goto Github PK

https://github.com/apiaryio/mson/blob/master/MSON%20Specification.md#44-sample

📇 https://trello.com/c/WekbhTVW

https://github.com/apiaryio/mson/blob/master/MSON%20Specification.md#22-named-types

As you can see in this screenshot, the attribute description text does not line up with the attribute name or the required/optional status icon.

📇 https://trello.com/c/PYjILypC

• Colors
• Fonts
• ...

Using stylint, perhaps?

📇 https://trello.com/c/PKHBWWPq

I just wanted to discuss built-in NPM tasks as it seems there's no convention and no structure around them.

Below is a list of the current NPM tasks.

• build
• playground
• lint
• start
• unit-tests
• visual-testing
• prepublish
• generate-fixtures

My proposal would be the following.

• npm start

  Spins up the development server.

  • By going to localhost:8080 (or localhost:8080/playground) you can try the Playground.
  • At /seed there's a demonstration of usage of the Seed.
  • When you hit /examples you can see a long list of examples, displayed in 3 columns—first column displays MSON, second Refract elements, the last one shows the rendered Attribtues Kit.

  Questions

  • /playground and /seed require a different Webpack build.
  • Both routes should reflect recent changes (= rebuild on change).

• test

  Run all test.

• test:unit

  Run all unit tests, optionally you can run them in the watch mode via npm run test:unit --watch.

• test:functional

• test:examples

• test:coverage

• lint

• build

  Build all.

• build:server

• build:browser

This value
- address: *street*, city, *state* (array, fixed)

Gets rendered as three array values

"value": {
          "element": "array",
          "content": [
            {
              "element": "string",
              "attributes": {
                "samples": [
                  "street"
                ]
              }
            },
            {
              "element": "string",
              "content": "city"
            },
            {
              "element": "string",
              "attributes": {
                "samples": [
                  "state"
                ]
              }
            }
          ]
        }

They are three different element.

npm WARN package.json [email protected] No license field.

and Author too.

https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md#data-structures-section

• UMD
• API

📇 https://trello.com/c/9Nvseh5W/569-build-for-aglio

Raised from this comment

📇 https://trello.com/c/Uvijf4O1

https://github.com/apiaryio/mson/blob/master/MSON%20Specification.md#5-type-inheritance

• ResourceAttributesComponent
• ActionAttributesComponent
• PayloadAttributesComponent

📇 https://trello.com/c/nJ9fpltz/568-build-for-apiary

Seed API

import {AttributesKit} from 'attributes-kit';

Render Shortcut

AttributesKit.render(refractElement, HTMLElement|String)

Using an Instance

let myAttributesKit = new AttributesKit({
  element: HTMLElement|String
});

myAttributesKit.render(refractElement)

The advantage of the instance is that you can subscribe to it.

myAttributesKit.on('click', Function);

Reference

• HTMLElement

We're passing quite often more data than needed for rendering components.

Example

        <div className="attributeObjectMemeberKey">
          <KeyComponent data={this.props.data} />
        </div>

        <div className="attributeObjectMemeberRequirement">
          <RequirementComponent data={this.props.data} />
        </div>

Both of them do not need the entire data object.

📇 https://trello.com/c/4Sw0kDZB/570-set-up-ci

This does not let us use its builtin validation (and furthermore, is throwing a lot of warnings)

• Visual Testing
• Unit Tests

📇 https://trello.com/c/JmkhvYG8/571-set-up-unit-tests
📇 https://trello.com/c/iQKCJoun/572-set-up-visual-testing