Build improvements #7

sgtcoolguy · 2019-10-15T14:46:09Z

change npm package to be under @titanium-sdk org
Add a whole lot of development dependencies to enforce linting/formatting
- lint apidocs
- eslint for JS
- clang-format for iOS source
- conventional commit enforcement
Fix up apidoc linting issues (around use of non-ASCII apostrophe/double-quotes, reference to non-existent type for array type)

This is mainly to try and align native modules and the SDK in enforcing some basic development workflows: conventional commits, clang-format for iOS/Android source, eslint for JS, some basic unit tests, validation of apidocs.

build · 2019-10-15T14:58:27Z

	Messages
📖	💾 Here are the artifacts produced: ti.applesignin-iphone-1.1.1.zip
📖	✅ All tests are passing Nice one! All 8 tests are passing.

Dependencies with modified semantic versioning:

karma-titanium-launcher - from ^0.7.4 to ^0.7.5

New dependencies added: @commitlint/cli, @commitlint/config-conventional, @seadub/clang-format-lint, clang-format, commitizen, husky, lint-staged and titanium-docgen.

@commitlint/cli

Author: Mario Nebl

Description: Lint your commit messages

Homepage: https://github.com/conventional-changelog/commitlint#readme


Created	over 2 years ago
Last Updated	30 days ago
License	MIT
Maintainers	4
Releases	54
Direct Dependencies	`@commitlint/format`, `@commitlint/lint`, `@commitlint/load`, `@commitlint/read`, `babel-polyfill`, `chalk`, `get-stdin`, `lodash`, `meow`, `resolve-from` and `resolve-global`
Keywords	conventional-changelog, commitlint and cli

README

Lint commit messages

@commitlint/cli

Getting started

npm install --save-dev @commitlint/cli @commitlint/config-angular
echo "module.exports = {extends: ['@commitlint/config-angular']};" > commitlint.config.js

Consult docs/cli for comprehensive documentation.

@commitlint/config-conventional

Author: Mario Nebl

Description: Shareable commitlint config enforcing conventional commits

Homepage: https://github.com/conventional-changelog/commitlint#readme


Created	almost 2 years ago
Last Updated	30 days ago
License	MIT
Maintainers	4
Releases	23
Keywords	conventional-changelog, commitlint, commitlint-config and angular

README

Lint your conventional commits

@commitlint/config-conventional

Shareable commitlint config enforcing conventional commits.
Use with @commitlint/cli and @commitlint/prompt-cli.

⚠️
IMPORTANT	This is a direct replacement for @commitlint/config-angular prior to version 4. `config-angular` diverged from the conventional commit convention as of version 5. See #146 for details.

Getting started

npm install --save-dev @commitlint/config-conventional @commitlint/cli
echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js

Rules

Problems

The following rules are considered problems for @commitlint/config-conventional and will yield a non-zero exit code when not met.

Consult docs/rules for a list of available rules.

type-enum

condition: type is found in value
rule: always

value

[
  'build',
  'ci',
  'chore',
  'docs',
  'feat',
  'fix',
  'perf',
  'refactor',
  'revert',
  'style',
  'test'
]

echo "foo: some message" # fails
echo "fix: some message" # passes

type-case

description: type is in case value
rule: always
value
```
  'lowerCase'
```

echo "FIX: some message" # fails
echo "fix: some message" # passes

type-empty

condition: type is empty
rule: never

echo ": some message" # fails
echo "fix: some message" # passes

scope-case

condition: scope is in case value
rule: always

  'lowerCase'

echo "fix(SCOPE): some message" # fails
echo "fix(scope): some message" # passes

subject-case

condition: subject is in one of the cases ['sentence-case', 'start-case', 'pascal-case', 'upper-case']
rule: never

echo "fix(SCOPE): Some message" # fails
echo "fix(SCOPE): Some Message" # fails
echo "fix(SCOPE): SomeMessage" # fails
echo "fix(SCOPE): SOMEMESSAGE" # fails
echo "fix(scope): some message" # passes
echo "fix(scope): some Message" # passes

subject-empty

condition: subject is empty
rule: never

echo "fix:" # fails
echo "fix: some message" # passes

subject-full-stop

condition: subject ends with value
rule: never
value

'.'

echo "fix: some message." # fails
echo "fix: some message" # passes

header-max-length

condition: header has value or less characters
rule: always
value

echo "fix: some message that is way too long and breaks the line max-length by several characters" # fails
echo "fix: some message" # passes

@seadub/clang-format-lint

Author: Christopher Williams

Description: Validate and/or fix formatting of files via clang-format

Homepage: https://github.com/sgtcoolguy/clang-format-lint#readme


Created	13 days ago
Last Updated	13 days ago
License	MIT
Maintainers	1
Releases	2
Direct Dependencies	`commander`, `glob` and `p-limit`
Keywords	clang, clang-format and lint

README

clang-format-lint

A very simple wrapper around the clang-format npm package/binary.

Intended to be used to either validate existing files, or automatically fix the formatting on them.

Usage:

npx clang-format-lint [--fix] [--exec-limit [limit]] glob[ glob]*

e.g. To check if your source files match your formatting rules:

npx clang-format-lint android/src/**/*.java

e.g. To ensure your source files match your formatting rules:

npx clang-format-lint --fix android/src/**/*.java

clang-format

Author: Unknown

Description: node wrapper around clang-format

Homepage: https://github.com/angular/clang-format#readme


Created	over 4 years ago
Last Updated	about 1 year ago
License	Apache-2.0
Maintainers	3
Releases	63
Direct Dependencies	`async`, `glob` and `resolve`

README

clang-format

node.js module which wraps the native clang-format executable.

From the command-line:

$ npm install -g clang-format
$ clang-format -help

If your platform isn't yet supported, you can create the native binary from
the latest upstream clang sources, make sure it is stripped and optimized
(should be about 1.4MB as of mid-2015) and send a pull request to add it.

Checking formatting

Ensuring that changes to your code are properly formatted is an important part
of your development workflow. We recommend using a git pre-commit hook. You can
configure this as follows:

add a precommit script to your package.json file:
```
"scripts": {
    "precommit": "check-clang-format"
}
```
By default, the user gets an error instructing them to run
./node_modules/.bin/git-clang-format. You may find it more ergonomic to set
up a package.json script, eg.
"scripts": { "format": "git-clang-format" }

In this case, add a second argument to the "precommit" script, giving the
error you'd like to print for users, eg.

"precommit": "check-clang-format \"yarn format\""
Add a devDependency on the husky package, which will add a
.git/hooks/pre-commit script, which in turn triggers the precommit
package.json script to run whenever someone adds a commit in this repository:
```
$ yarn add -D husky
```
or
```
npm install --save-dev husky
```

Why do this in a pre-commit hook? For one thing, it's faster to run
clang-format only on the changed files, especially as the repository grows.
Also, this lets you upgrade clang-format or change your settings without
needing to re-format the entire repository, while still enforcing that later
changes follow the new style.

Globbing files

$ clang-format --glob=folder/**/*.js

This will run clang-format once per file result, and show the total
formatted files at the end.
See node-glob for globbing semantics.

Compiling clang-format

For Linux, compile a statically linked MinSizeRel build:

cmake -G Ninja -DCMAKE_BUILD_TYPE=MinSizeRel -DLLVM_BUILD_STATIC=true ..
ninja clang-format

For Mac OS X, static linking is not required.

Windows

Windows snapshot builds to include in the release can be found at the
LLVM website.

Configure with:

cmake -G "Visual Studio 12" -DCMAKE_BUILD_TYPE=MinSizeRel ..

In the generated Visual Studio project, search for the clang-format binary in
the Solution Explorer window, right click and choose Build.

commitizen

Author: Jim Cummins

Description: Git commit, but play nice with conventions.

Homepage: https://github.com/commitizen/cz-cli


Created	over 4 years ago
Last Updated	3 months ago
License	MIT
Maintainers	5
Releases	64
Direct Dependencies	`cachedir`, `cz-conventional-changelog`, `dedent`, `detect-indent`, `find-node-modules`, `find-root`, `fs-extra`, `glob`, `inquirer`, `is-utf8`, `lodash`, `minimist`, `shelljs`, `strip-bom` and `strip-json-comments`
Keywords	commit, pretty, format, conventional changelog and commitizen

This README is too long to show.

husky

Author: Typicode

Description: Prevents bad commit or push (git hooks, pre-commit/precommit, pre-push/prepush, post-merge/postmerge and all that stuff...)

Homepage: https://github.com/typicode/husky#readme


Created	over 5 years ago
Last Updated	4 days ago
License	MIT
Maintainers	1
Releases	133
Direct Dependencies	`chalk`, `ci-info`, `cosmiconfig`, `execa`, `get-stdin`, `opencollective-postinstall`, `pkg-dir`, `please-upgrade-node`, `read-pkg`, `run-node` and `slash`
Keywords	git, hook, hooks, pre-commit, precommit, post-commit, postcommit, pre-push, prepush, post-merge, postmerge, test and lint

This README is too long to show.

lint-staged

Author: Andrey Okonetchnikov

Description: Lint files staged by git

Homepage: https://github.com/okonet/lint-staged#readme


Created	almost 4 years ago
Last Updated	9 days ago
License	MIT
Maintainers	1
Releases	111
Direct Dependencies	`chalk`, `commander`, `cosmiconfig`, `debug`, `dedent`, `del`, `execa`, `listr`, `log-symbols`, `micromatch`, `normalize-path`, `please-upgrade-node`, `string-argv` and `stringify-object`
Keywords	lint, git, staged, eslint, prettier, stylelint, code, quality, check, format and validate

This README is too long to show.

titanium-docgen

Author: Axway Appcelerator

Description: Generates Titanium API documentation in different formats

Homepage: https://github.com/appcelerator/docs-devkit#readme


Created	3 months ago
Last Updated	about 1 month ago
License	Apache-2.0
Maintainers	1
Releases	4
Direct Dependencies	`colors`, `ejs`, `js-yaml`, `markdown-it` and `node-appc`
Keywords	titanium, docgen, documentation and docs

README

titanium-docgen

Generates Titanium API documentation in different formats

Installation

npm i titanium-docgen -D

Usage

node docgen [--addon-docs <PATH_TO_YAML_FILES] [--css <CSS_FILE>] [--format <EXPORT_FORMAT>] [--output <OUTPUT_DIRECTORY>] <PATH_TO_YAML_FILES>

For a description of each option. run docgen --help.

Supported formats

Format	Description
`addon`
`changes`
`html`	HTML files for the official docs at https://docs.appcelerator.com
`jsca`	JSCA content assist metadata
`jsduck`	https://github.com/senchalabs/jsduck
`json`	JSON metadata file
`json-raw`	Same as `json`, but with no pre-rendered markdown
`modulehtml`
`parity`
`solr`	Solr search index
`typescript`	TypeScript type definition file

Generated by 🚫 dangerJS against 712b757

sgtcoolguy added 25 commits October 15, 2019 10:23

chore: update npm org name

f52a8da

style: add npm scripts/config for linting

c2bce44

chore(package): add titanium-docgen 0.2.0 as devDependency

d8136c6

chore(package): update lockfile

6f857b5

chore(package): add lint-staged 9.4.1 as devDependency

a84650e

chore(package): update lockfile

581779b

chore(package): add update karma-titanium-launcher to 0.7.5

9ea5e42

chore(package): update lockfile

2a61e8e

chore(package): add husky 3.0.8 as devDependency

3c16125

chore(package): update lockfile

d700609

chore(package): add @commitlint/cli 8.2.0 as devDependency

234bf7c

chore(package): update lockfile

d0ec800

chore(package): add @commitlint/config-conventional 8.2.0

e974f8f

chore(package): update lockfile

8d23590

chore(package): add @seadub/clang-format-lint 0.0.2

876777a

chore(package): update lockfile

7ff8940

chore(package): add clang-format 1.2.3

6122a25

chore(package): update lockfile

596d81c

chore(package): add commitizen 4.0.3

2bc0ad1

chore(package): update lockfile

c7361b9

build: remove reference to linting android

4a4ee6b

style: add clang format file

f7bdc38

style: make clang format happy

0d9e490

build: fix recursive npm test definition

a468009

docs: fix apidoc linting issues

ddbb116

sgtcoolguy added 4 commits October 15, 2019 11:28

style: add eslint config files

5820765

style(js): fix eslint errors

4cabade

chore(package): use clang-format 1.2.3

162245d

chore(package): update lockfile

10fb189

style(ios): fix formatting

d9b86ee

sgtcoolguy mentioned this pull request Oct 15, 2019

Build improvements tidev/titanium-identity#40

Merged

sgtcoolguy requested a review from vijaysingh-axway October 15, 2019 15:34

This was referenced Oct 15, 2019

Build improvements tidev/ti.map#281

Merged

Build improvements tidev/ti.facebook#111

Merged

Build improvements tidev/appcelerator.encrypteddatabase#42

Closed

sgtcoolguy requested a review from ewanharris October 16, 2019 17:11

chore: remove unused platform directory

712b757

sgtcoolguy merged commit 712b757 into master Oct 16, 2019

sgtcoolguy deleted the build-improvements branch October 16, 2019 18:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Build improvements #7

Build improvements #7

sgtcoolguy commented Oct 15, 2019 •

edited

Loading

build commented Oct 15, 2019 •

edited

Loading

@commitlint/cli

Getting started

@commitlint/config-conventional

Getting started

Rules

Problems

type-enum

type-case

type-empty

scope-case

subject-case

subject-empty

subject-full-stop

header-max-length

clang-format-lint

clang-format

From the command-line:

Checking formatting

Globbing files

Compiling clang-format

Windows

titanium-docgen

Installation

Usage

Supported formats

Build improvements #7

Build improvements #7

Conversation

sgtcoolguy commented Oct 15, 2019 • edited Loading

build commented Oct 15, 2019 • edited Loading

@commitlint/cli

Getting started

@commitlint/config-conventional

Getting started

Rules

Problems

type-enum

type-case

type-empty

scope-case

subject-case

subject-empty

subject-full-stop

header-max-length

clang-format-lint

clang-format

From the command-line:

Checking formatting

Globbing files

Compiling clang-format

Windows

titanium-docgen

Installation

Usage

Supported formats

sgtcoolguy commented Oct 15, 2019 •

edited

Loading

build commented Oct 15, 2019 •

edited

Loading