Add copyright boilerplate generation for proposals

Author: bterlson

boilerplate/proposal-copyright.html

@@ -0,0 +1 @@
+<p>© !YEAR! !CONTRIBUTORS!</p>

lib/Spec.js

@@ -89,6 +89,14 @@ module.exports = class Spec {
     if (!this.opts.date) {
       this.opts.date = new Date();
     }
+
+    if (this.opts.stage) {
+      this.opts.stage = String(this.opts.stage);
+    } else if (this.opts.status === 'proposal') {
+      this.opts.stage = '0';
+    } else {
+      this.opts.stage = null;
+    }
   }
 
   buildAll(selector, Builder, opts) {
@@ -246,11 +254,16 @@ module.exports = class Spec {
     const version = this.opts.version;
     const title = this.opts.title;
     const shortname = this.opts.shortname;
-    const stage = this.opts.stage === undefined ? null : String(this.opts.stage);
+    const stage = this.opts.stage;
 
-    if (this.opts.copyright && (status === 'draft' || status === 'standard')) {
-      this.buildCopyrightBoilerplate();
+    if (this.opts.copyright) {
+      if (status !== 'draft' && status !== 'standard' && !this.opts.contributors) {
+        utils.logWarning('Contributors not specified, skipping copyright boilerplate. Specify contributors in your frontmatter metadata.');
+      } else {
+        this.buildCopyrightBoilerplate();
+      }
     }
+
     // no title boilerplate generated if title not specified
     if (!title) return;
 
@@ -305,16 +318,34 @@ module.exports = class Spec {
       copyright = fs.readFileSync('boilerplate/draft-copyright.html', 'utf8');
     } else if (this.opts.status === 'standard') {
       copyright = fs.readFileSync('boilerplate/standard-copyright.html', 'utf8');
+    } else {
+      copyright = fs.readFileSync('boilerplate/proposal-copyright.html', 'utf8');
+    }
+
+    copyright = copyright.replace(/!YEAR!/g, this.opts.date.getFullYear());
+
+    if (this.opts.contributors) {
+      copyright = copyright.replace(/!CONTRIBUTORS!/g, this.opts.contributors);
     }
 
     const softwareLicense = fs.readFileSync('boilerplate/software-license.html', 'utf8');
 
-    let lastAnnex = this.doc.querySelector('body > emu-annex:last-child');
-    let lastClause = this.doc.querySelector('body > emu-clause:last-child');
-    const last = lastAnnex || lastClause;
+    let copyrightClause = this.doc.querySelector('.copyright-and-software-license');
+    if (!copyrightClause) {
+      let lastAnnex = this.doc.querySelector('body > emu-annex:last-child');
+      let lastClause = this.doc.querySelector('body > emu-clause:last-child');
+      const last = lastAnnex || lastClause;
+
+      copyrightClause = this.doc.createElement('emu-annex');
+      copyrightClause.setAttribute('id', 'sec-copyright-and-software-license');
+
+      if (last) {
+        last.parentNode.insertBefore(copyrightClause, last.previousSibling);
+      } else {
+        this.doc.body.appendChild(copyrightClause);
+      }
+    }
 
-    const copyrightClause = this.doc.createElement('emu-annex');
-    copyrightClause.setAttribute('id', 'sec-copyright-and-software-license');
     copyrightClause.innerHTML = `
       <h1>Copyright &amp; Software License</h1>
       <h2>Copyright Notice</h2>
@@ -323,11 +354,6 @@ module.exports = class Spec {
       ${softwareLicense}
     `;
 
-    if (last) {
-      last.parentNode.insertBefore(copyrightClause, last.previousSibling);
-    } else {
-      this.doc.body.appendChild(copyrightClause);
-    }
   }
 
   autolink() {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ecmarkup",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Custom element definitions and core utilities for markup that specifies ECMAScript and related technologies.",
   "main": "lib/ecmarkup.js",
   "scripts": {

spec/index.html

@@ -60,6 +60,7 @@ <h1>Useful Options</h1>
         <tr><td>shortname</td><td>Shortname of specification, for example `ECMA-262` or `ECMA-402`.</td></tr>
         <tr><td>location</td><td>URL of this specification. Use in conjunction with the biblio file to enable external specs to reference this one.</td></tr>
         <tr><td>copyright</td><td>Emit copyright and software license information. Boolean, default true.</td></tr>
+        <tr><td>contributors</td><td>Contributors to this specification, ie. those who own the copyright. If your proposal includes text from any Ecma specification, you should include "Ecma International" in this list.</td></tr>
         <tr><td>toc</td><td>Emit table of contents. Boolean, default true.</td></tr>
         <tr><td>old-toc</td><td>Emit the old style of table of contents. Boolean, default false.</td></tr>
       </table>

test/algorithms.html

@@ -1,4 +1,7 @@
-<pre class=metadata>toc: false</pre>
+<pre class=metadata>
+toc: false
+copyright: false
+</pre>
 <emu-biblio href="./algorithmsBiblio.json"></emu-biblio>
 <emu-alg>
   1. Can call abstract operations in this spec: Internal();

test/build.js

@@ -4,7 +4,7 @@ const Promise = require('bluebird');
 
 const build = require('../lib/ecmarkup').build;
 
-const doc = '<!doctype html><pre class=metadata>toc: false</pre><emu-clause><h1>hi</h1></emu-clause>';
+const doc = '<!doctype html><pre class=metadata>toc: false\ncopyright: false</pre><emu-clause><h1>hi</h1></emu-clause>';
 const out = '<!doctype html>\n<head><meta charset="utf-8"></head><body><emu-clause><h1><span class="secnum">1</span>hi<span class="utils"><span class="anchor"><a href="#">#</a></span></span></h1></emu-clause></body>';
 function fetch(file) {
   if (file.match(/\.json$/)) {

test/charset-absent.html

@@ -1 +1,4 @@
-<pre class=metadata>toc: false</pre>
+<pre class=metadata>
+toc: false
+copyright: false
+</pre>

test/charset-present.html

@@ -1,3 +1,6 @@
 <meta charset="ascii">
-<pre class=metadata>toc: false</pre>
+<pre class=metadata>
+toc: false
+copyright: false
+</pre>
 

test/clauses.html

@@ -1,4 +1,7 @@
-<pre class=metadata>oldToc: true</pre>
+<pre class=metadata>
+oldToc: true
+copyright: false
+</pre>
 <emu-intro>
   <h1>Intro</h1>
   <emu-intro>

test/dfn.html

@@ -1,4 +1,7 @@
-<pre class=metadata>toc: false</pre>
+<pre class=metadata>
+toc: false
+copyright: false
+</pre>
 <emu-intro id="sec-intro">
   <h1>Intro</h1>
   <p>Forward references to dfn work.</p>