💥 Rename asciidoctor.js to asciidoctor (#694)

* Rename asciidoctor.js to asciidoctor
- Move everything to packages/core
- Create a meta package named asciidoctor
- Create a core package named @asciidoctor/core
- Add an alias asciidoctor -> @asciidoctor/core
* Update the release and publish tasks
* Update README
* Update the documentation

Author: ggrossetie

.gitignore

@@ -1,3 +1,2 @@
-/build/
 /node_modules/
 npm-debug.log

.travis.yml

@@ -18,35 +18,31 @@ jdk:
 
 install:
 - npm ci
+- npm ci --prefix packages/core
+
 # keep the npm cache around to speed up installs
 cache:
   directories:
   - "$HOME/.npm"
 
 script:
 - npm run lint
-- npm run package
-- npm run docs
-- SKIP_BUILD=1 npm run examples
-- npm run test:graalvm # test against GraalVM
+- npm run test
+- npm run travis --prefix packages/core
 
 jobs:
   include:
     - stage: release
       if: |
         repo = 'asciidoctor/asciidoctor.js' AND \
         tag IS present
-      script: ./scripts/package.sh
+      script:
+      - ./scripts/package.sh
+      - ./scripts/publish.sh
       deploy:
-        - provider: npm
-          skip_cleanup: true
-          email: ${NPM_USER_EMAIL}
-          api_key: ${NPM_USER_API_KEY}
-          on:
-            tags: true
         - provider: releases
           api_key: ${GITHUB_TOKEN}
-          file: bin/asciidoctor.js.dist.*
+          file: packages/core/bin/asciidoctor.js.dist.*
           skip_cleanup: true
           file_glob: true
           on:

CONTRIBUTING-CODE.adoc

@@ -35,10 +35,10 @@ Start by cloning the source from GitHub:
 
  $ git clone https://github.com/asciidoctor/asciidoctor.js.git
 
-Next, switch to the _asciidoctor.js_ directory and run npm's `install` command:
+Next, switch to the _asciidoctor.js/packages/core_ directory and run npm's `install` command:
 
- $ cd asciidoctor.js
-   npm install
+ $ cd asciidoctor.js/packages/core
+   npm i
 
 You're now ready to build Asciidoctor.js.
 

README.adoc

@@ -29,79 +29,48 @@ Asciidoctor.js brings AsciiDoc to the JavaScript world!
 This project uses {uri-opal}[Opal] to transpile http://asciidoctor.org[Asciidoctor], a modern implementation of AsciiDoc, from Ruby to JavaScript to produce _asciidoctor.js_.
 The _asciidoctor.js_ script can be run on any JavaScript platform, including Node.js, GraalVM and, of course, a web browser.
 
-IMPORTANT: Asciidoctor.js does _not_ use Semantic Versioning as the release versions are aligned on _Asciidoctor (Ruby)_. It's *highly recommended* to define the exact version in your `package.json` file (ie. without `^`). Please read the release notes when upgrading to the latest version as breaking changes can be introduced in non major release.
+== Quickstart
 
-== Introduction
-
-You can use Asciidoctor.js either for back-end development using {uri-nodejs}[Node.js] or front-end development using a browser.
-
-== Front-end development
-
-.Installing Asciidoctor.js with npm
-
-    $ npm install asciidoctor.js --save
-
-Once the package is installed, you can add the following `script` tag to your HTML page:
-
-```html
-<script src="node_modules/asciidoctor.js/dist/browser/asciidoctor.js"></script>
-```
+ $ npm i asciidoctor --save
 
 Here is a simple example that converts AsciiDoc to HTML5:
 
 .sample.js
-
-```javascript
-var asciidoctor = Asciidoctor(); // <1>
-var content = "http://asciidoctor.org[*Asciidoctor*] " +
-    "running on https://opalrb.com[_Opal_] " +
-    "brings AsciiDoc to the browser!";
-var html = asciidoctor.convert(content); // <2>
-console.log(html); // <3>
-```
-
-<1> Instantiate the Asciidoctor.js library
-<2> Convert AsciiDoc content to HTML5 using Asciidoctor.js
-<3> Print the HTML5 output to the console
-
-== Back-end development
-
-.Installing Asciidoctor.js with npm
-
-    $ npm install asciidoctor.js --save
-
-Once the package is installed, the first thing to do is to load the `asciidoctor.js` module using `require`, then you're ready to start using the API:
-
-.sample.js
-
-```javascript
-var asciidoctor = require('asciidoctor.js')(); // <1>
-var content = "http://asciidoctor.org[*Asciidoctor*] " +
-    "running on https://opalrb.com[_Opal_] " +
-    "brings AsciiDoc to Node.js!";
-var html = asciidoctor.convert(content); // <2>
-console.log(html); // <3>
-```
-
+[source,javascript]
+----
+const asciidoctor = require('asciidoctor')() // <1>
+const content = 'http://asciidoctor.org[*Asciidoctor*] ' +
+  'running on https://opalrb.com[_Opal_] ' +
+  'brings AsciiDoc to Node.js!'
+const html = asciidoctor.convert(content) // <2>
+console.log(html) // <3>
+----
 <1> Instantiate the Asciidoctor.js library
 <2> Convert AsciiDoc content to HTML5 using Asciidoctor.js
 <3> Print the HTML5 output to the console
 
-Save the file as `sample.js` and run it using the `node` command:
+Save the file as _sample.js_ and run it using the `node` command:
 
  $ node sample.js
 
 You should see the following output in your terminal:
 
-[.output]
+[source.output,html]
+----
+<div class="paragraph">
+<p><a href="http://asciidoctor.org"><strong>Asciidoctor</strong></a> running on <a href="http://opalrb.com"><em>Opal</em></a> brings AsciiDoc to Node.js!</p>
+</div>
+----
 
-    <div class="paragraph">
-    <p><a href="http://asciidoctor.org"><strong>Asciidoctor</strong></a> running on <a href="http://opalrb.com"><em>Opal</em></a> brings AsciiDoc to Node.js!</p>
-    </div>
+It's also possible to use the following `script` tag directly into your HTML page:
+
+```html
+<script src="node_modules/@asciidoctor/core/dist/browser/asciidoctor.js"></script>
+```
 
-== Advanced topics
+== Learning
 
-If you want to know more about _Asciidoctor.js_, please read the {uri-user-manual}[User Manual].
+If you want to learn more about _Asciidoctor.js_, please read the {uri-user-manual}[User Manual].
 
 == Contributing
 

appveyor.yml

@@ -12,9 +12,10 @@ environment:
   ASCIIDOCTOR_CORE_VERSION: "master"
 
 install:
-  # Get the latest stable version of Node.js
-  - ps: Install-Product node $env:nodejs_version
-  - npm ci
+# Get the latest stable version of Node.js
+- ps: Install-Product node $env:nodejs_version
+- cd packages/core
+- npm ci
 
 build_script:
 - node tasks/build.js

docs/modules/extend/pages/converter/custom-converter.adoc

@@ -157,7 +157,7 @@ In the example below we will use a custom converter to convert `paragraph` but t
 
 [source,js]
 ----
-const asciidoctor = require('asciidoctor.js')()
+const asciidoctor = require('asciidoctor')()
 
 class SemanticParagraphConverter {
   constructor () {

docs/modules/extend/pages/extensions/block-macro-processor.adoc

@@ -19,7 +19,7 @@ include::example$extensions/lorem-block-macro.js[]
 == Usage
 
 ```js
-const asciidoctor = require('asciidoctor.js')()
+const asciidoctor = require('asciidoctor')()
 const registry = asciidoctor.Extensions.create()
 require('./lorem-block-macro.js')(registry)
 

docs/modules/extend/pages/extensions/block-processor.adoc

@@ -21,7 +21,7 @@ include::example$extensions/shout-block.js[]
 == Usage
 
 ```js
-const asciidoctor = require('asciidoctor.js')()
+const asciidoctor = require('asciidoctor')()
 const registry = asciidoctor.Extensions.create()
 require('./shout-block.js')(registry)
 

docs/modules/extend/pages/extensions/compile-ruby-extension.adoc

@@ -81,7 +81,7 @@ Next we create a Node script to convert this document:
 .convert.js
 [source,javascript]
 ----
-const asciidoctor = require('asciidoctor.js')()
+const asciidoctor = require('asciidoctor')()
 require('./tel-inline-macro.js') // <1>
 
 const html = asciidoctor.convertFile('document.adoc', { 'to_file': false }) // <2>

docs/modules/extend/pages/extensions/docinfo-processor.adoc

@@ -23,7 +23,7 @@ include::example$extensions/love-footer-docinfo-processor.js[]
 == Usage
 
 ```js
-const asciidoctor = require('asciidoctor.js')()
+const asciidoctor = require('asciidoctor')()
 const registry = asciidoctor.Extensions.create()
 require('./love-footer-docinfo-processor.js')(registry)