refactor: use external compiler package by janvennemann · Pull Request #952 · tidev/alloy

janvennemann · 2020-01-24T00:24:43Z

JIRA: https://jira.appcelerator.org/browse/ALOY-1725

This rips out everything that is relating to compiling Alloy components and moves it into a new package. The goal is to get a reusable compiler package that can be used across different projects. A first example of this is the alloy-loader.

Overview of the changes this PR contains:

Moved compiler into new alloy-compiler package.
Moved shared utilities into new alloy-utils package
Updated the code in this repo to use the newly created packages.
Updated unit tests to use the new packages. Moved over the test for the optimizer-plugin to alloy-compiler. The actual compiler tests are still in this repo since they rely on all the test apps in this repo and i didn't want to move too much stuff around. Also they are built on outdated tools like jake and Jasmine v1.x, so i'd prefer to update the testing setup before moving all that into the new alloy-compiler package.
Removed references to mobileweb as a platform.

man, this was ugly

build · 2020-01-24T00:29:13Z

	Warnings
⚠️	Please ensure to add a changelog entry for your changes. Edit the `CHANGELOG.md` file and add your change under the `Unreleased items` header

	Messages
📖	✅ All tests are passing Nice one! All 1847 tests are passing.

New dependencies added: alloy-compiler, alloy-utils and strip-ansi.

alloy-compiler

Author: Axway Appcelerator

Description: Compiler for Alloy components

Homepage: https://github.com/appcelerator/alloy-devkit/tree/develop/packages/alloy-compiler#readme


Created	4 months ago
Last Updated	3 days ago
License	Apache-2.0
Maintainers	1
Releases	8
Direct Dependencies	`@babel/generator`, `@babel/parser`, `@babel/traverse`, `@babel/types`, `alloy-utils`, `chmodr`, `fs-extra`, `jsonlint`, `lodash`, `node.extend`, `walk-sync` and `xmldom`
Keywords	alloy and compiler

README

alloy-compiler

Compiler for Alloy components

This packages contains the standalone Alloy compiler. In most cases you should be using it in Webpack powered Alloy projects, you will only need it separately if you are writing build tools with very specific needs.

Installation

npm i alloy-compiler

Usage

const { createCompiler, createCompileConfig } = require('alloy-compiler');

API

createCompiler(options)

Creates a new Alloy compiler instance.

Example

const { createCompiler } = require('alloy-compiler');
const compiler = createCompiler({
  compileConfig: {
    projectDir: '/path/to/my/project',
    alloyConfig: {
      platform: 'ios',
      deploytype: 'development'
    }
  },
  webpack: true
});

Options

Expects an options object with the following properties:

compileConfig
- Type: object
Configuration that will be passed to the Alloy compiler.

You can either pass an object returned by createCompileConfig or directly pass the same options accepted by that function. The config object will then be created from the passed options.
webpack
- Type: boolean
- Default: false
Whether or not to create a special compiler instance that creates optimized output Webpack.

createCompileConfig(options)

Creates a new Alloy compile configuration based on the passed options.

Example

const { createCompileConfig } = require('alloy-compiler');
const compileConfig = createCompileConfig({
  projectDir: '/path/to/my/project',
  alloyConfig: {
    platform: 'ios',
    deploytype: 'development'
  }
});

Parameters

Expects an options object with the following properties:

projectDir
- Type: string
Path to the root directory of the Alloy project.

alloyConfig

Type: object

Alloy configuration. Expects an object with the following structure:

{
  platform: string // 'ios' or 'android'
  deploytype: string // 'development', 'test' or 'production'
}

logLevel
- Type: number
- Default: logger.ERROR
Log level for the internal logger.
buildLog
- Type: BuildLog
- Default: BuildLog for the specified projectDir

compiler.compileComponent(options)

Compiles the controller and view of an Alloy component.

Returns a result object with the following structure:

{
  code: string,
  map: object, // Source map
  dependencies: array // List of dependencies used during compilation like view and style file
}

Example

const { createCompiler } = require('alloy-compiler');
const compiler = createCompiler({
  compileConfig: {
    projectDir: '/path/to/my/project',
    alloyConfig: {
      platform: 'ios',
      deploytype: 'development'
    }
  }
});
const result = compiler.compileComponent({
  file: '/path/to/my/project/app/controllers/index.js'
});

Parameters

Expects an options object with the following properties:

file
- Type: string
Full path to the controller or view file that should be compiled. The compiler will automatically look for all possible associated files of the component (controller/view/style) and process them.
content
- Type: string
Content of file, if already known. The compiler will automatically read the file's content if this is omitted.
inputSourceMap
- Type: object
Input source map. The compiler will create a new source map if this is omitted.

alloy-utils

Author: Axway Appcelerator

Description: Common utils for Alloy

Homepage: https://github.com/appcelerator/alloy-devkit/tree/develop/packages/alloy-utils#readme


Created	4 months ago
Last Updated	3 days ago
License	Apache-2.0
Maintainers	1
Releases	7
Direct Dependencies	`@babel/code-frame`, `chmodr`, `colors`, `fs-extra`, `global-paths`, `jsonlint`, `lodash`, `moment`, `resolve` and `xmldom`
Keywords	alloy, common and utils

README

alloy-utils

Alloy utility library

Installation

npm i alloy-utils

Usage

const {
  utils, // Utility functions
  logger, // Alloy logger
  constants, // Constants used in Alloy
  platforms, // Platform information
  tiapp, // Utils to work with tiapp.xml
  tssGrammar // TSS grammar defintion
} = require('alloy-utils');

strip-ansi

Author: Sindre Sorhus

Description: Strip ANSI escape codes from a string

Homepage: https://github.com/chalk/strip-ansi#readme


Created	over 6 years ago
Last Updated	6 months ago
License	MIT
Maintainers	2
Releases	16
Direct Dependencies	`ansi-regex`
Keywords	strip, trim, remove, ansi, styles, color, colour, colors, terminal, console, string, tty, escape, formatting, rgb, 256, shell, xterm, log, logging, command-line and text

README

strip-ansi

Strip ANSI escape codes from a string

Install

$ npm install strip-ansi

Usage

const stripAnsi = require('strip-ansi');

stripAnsi('\u001B[4mUnicorn\u001B[0m');
//=> 'Unicorn'

stripAnsi('\u001B]8;;https://github.com\u0007Click\u001B]8;;\u0007');
//=> 'Click'

strip-ansi for enterprise

Available as part of the Tidelift Subscription.

The maintainers of strip-ansi and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

Maintainers

Generated by 🚫 dangerJS against af691f2

ewanharris

Generally looks good, some comments but only the version number comment is required. Incredible work @janvennemann!

Moving on to do some more thorough testing

ewanharris · 2020-04-20T11:14:11Z

Alloy/commands/compile/index.js

-		path.join(paths.resources, titaniumFolder, 'alloy'),
-		{ rootDir: paths.project, restrictionPath: restrictionPath }
+	// NOTE: copies `alloy-utils/lib/constants.js` into `<project-dir>/Resources/<platform>/alloy`
+	U.copyFileSync(


I don't think it's a huge deal as it's only the constants file, but we'd lose the restrictionPath filtering by just using copyFileSync here

ewanharris · 2020-04-21T12:55:42Z

Alloy/commands/compile/index.js

 	});
+	let finalCode = code;
+	const relativeOutfile = path.relative(compileConfig.dir.project, componentOutputPath);
+	if (compileConfig.sourcemap !== false) {


Note to self to check debugging in studio/vscode

ewanharris · 2020-04-21T13:53:36Z

Alloy/commands/compile/index.js

 		});
 	}

+	// TODO: Remove once @titanium-sdk/babel-preset-app is in place


Is this an ALOY ticket to handle, or will it be done at the SDK level?

Alloy/commands/compile/index.js

…file

janvennemann added 8 commits November 29, 2019 00:06

refactor: use external compiler package

658ecf5

fix: mobile web is dead

145d3a7

refactor: remove duplicate code

b148383

chore: remove path.existsSync hack

177386f

man, this was ugly

fix: update to latest compiler api

f85b413

fix: add missing log

7658488

style: use old method name

2f493c2

chore(package): update dependencies

229c579

janvennemann added 8 commits January 24, 2020 20:20

fix: get unit tests working

5fb354c

fix: mobileweb is still dead

cca5680

fix: require logger from alloy-utils

09ba349

chore: update deps

daff0d7

fix: pass correct options format to compileStyle

c204103

fix: restore old platforms list

c2a1634

chore: remove mobileweb and blackberry references

bb07171

chore: update dependencies

74234c8

janvennemann added this to the 2.0.0 milestone Mar 4, 2020

janvennemann marked this pull request as ready for review March 4, 2020 13:43

janvennemann added 2 commits March 4, 2020 15:14

Merge branch 'master' into external-compiler

0805ac0

chore(package): update compiler

0b2c639

janvennemann requested a review from ewanharris March 4, 2020 14:56

ewanharris mentioned this pull request Mar 9, 2020

[ALOY-1722] Make alloy work as required module #956

Open

ewanharris changed the base branch from master to next March 10, 2020 11:25

ewanharris mentioned this pull request Mar 25, 2020

Remove os:windows from config.json #957

Merged

fix: update alloy-compiler

f778201

ewanharris reviewed May 19, 2020

View reviewed changes

fix(compile): pass in version from commander when rendering alloy.js …

af691f2

…file

Uh oh!

Conversation

janvennemann commented Jan 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

build commented Jan 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

alloy-compiler

alloy-compiler

Installation

Usage

API

createCompiler(options)

Example

Options

createCompileConfig(options)

Example

Parameters

compiler.compileComponent(options)

Example

Parameters

alloy-utils

alloy-utils

Installation

Usage

strip-ansi

strip-ansi

Install

Usage

strip-ansi for enterprise

Related

Maintainers

Uh oh!

ewanharris left a comment

Choose a reason for hiding this comment

Uh oh!

ewanharris Apr 20, 2020

Choose a reason for hiding this comment

Uh oh!

ewanharris Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

ewanharris Apr 21, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

janvennemann commented Jan 24, 2020 •

edited

Loading

build commented Jan 24, 2020 •

edited

Loading