LTR - inclusive language and tgz ignore (#138)

* update inclusive language

* ignore tgz file

Author: catherine-hpr

.gitignore

@@ -1,4 +1,5 @@
 node_modules
 coverage
 *.log
+*.tgz
 .vscode

lib/archiver.js

@@ -11,40 +11,40 @@ const REQUIRED_ENTRIES = [
   'node_modules'
 ];
 
-function getEntries(whitelist) {
-  if (whitelist.files) {
-    // Extract the property from the whitelist
-    const { service, main, files } = whitelist;
-    const whitelistFromSections = [service];
+function getEntries(allowlist) {
+  if (allowlist.files) {
+    // Extract the property from the allowlist
+    const { service, main, files } = allowlist;
+    const allowlistFromSections = [service];
 
     /*
      * It flattens the content of both properties (main and files) in the
-     * "whitelistFromSections" array.
+     * "allowlistFromSections" array.
      */
     if (main) {
-      whitelistFromSections.push(main);
+      allowlistFromSections.push(main);
     }
 
     if (files) {
-      whitelistFromSections.push(...files);
+      allowlistFromSections.push(...files);
     }
 
-    if (!whitelistFromSections.length) {
+    if (!allowlistFromSections.length) {
       return;
     }
 
-    return REQUIRED_ENTRIES.concat(whitelistFromSections);
+    return REQUIRED_ENTRIES.concat(allowlistFromSections);
   }
 }
 
-module.exports.compress = async function (source, target, whitelist) {
+module.exports.compress = async function (source, target, allowlist) {
   const gzip = zlib.createGzip();
   const ws = fs.createWriteStream(target);
   const rs = tar.pack(source, {
     ignore: function (name) {
       return IGNORE_REGEX.test(path.relative(source, name));
     },
-    entries: getEntries(whitelist)
+    entries: getEntries(allowlist)
   });
 
   return new Promise((resolve, reject) => {

lib/generate.js

@@ -40,7 +40,7 @@ function relativeToRoot(root, files) {
   });
 }
 
-function getArchiveWhitelist(pkg, customName) {
+function getArchiveAllowlist(pkg, customName) {
   return {
     service: files.serviceFileName(customName || pkg.name),
     main: pkg.main,
@@ -59,9 +59,9 @@ module.exports = async (root, pkg, release, customName) => {
 
   const serviceFile = generateServiceFile(root, customPackage);
   const specFile = generateSpecFile(specsDirectory, customPackage, release);
-  const archiveWhitelist = getArchiveWhitelist(pkg, customName);
+  const archiveAllowlist = getArchiveAllowlist(pkg, customName);
 
-  await archiver.compress(root, sourcesArchive, archiveWhitelist);
+  await archiver.compress(root, sourcesArchive, archiveAllowlist);
 
   return relativeToRoot(root, [
     specFile,

test/archiver.js

@@ -77,7 +77,7 @@ describe('archiver', () => {
     assert.equal(ignore('/tmp/SOURCES/cake/real_file_here'), false);
   });
 
-  it('archives files on a whitelist if specified alongside required files', async () => {
+  it('archives files on a allowlist if specified alongside required files', async () => {
     const service = 'my-cool-api.service';
     const files = [
       'lib',
@@ -101,7 +101,7 @@ describe('archiver', () => {
     }));
   });
 
-  it('does not include whitelist if none specified', async () => {
+  it('does not include allowlist if none specified', async () => {
     const service = 'my-cool-api.service';
     const result = archiver.compress('/tmp/SOURCES', 'tmp.tar.gz', { service });
     writeStream.emit('close');

…fixtures/my-cool-api-with-whitelist.json …fixtures/my-cool-api-with-allowlist.jsontest/fixtures/my-cool-api-with-whitelist.json renamed to test/fixtures/my-cool-api-with-allowlist.json test/fixtures/my-cool-api-with-whitelist.json renamed to test/fixtures/my-cool-api-with-allowlist.json

@@ -1,7 +1,7 @@
 'use strict';
 
 const pkg = require('./fixtures/my-cool-api');
-const pkgWithWhitelist = require('./fixtures/my-cool-api-with-whitelist');
+const pkgWithAllowlist = require('./fixtures/my-cool-api-with-allowlist');
 const sandbox = require('sinon').createSandbox();
 const fs = require('fs');
 const assert = require('assert');
@@ -118,7 +118,7 @@ describe('generate', () => {
   });
 
   it('passes files and main values from the package.json to archiver', async () => {
-    await generate('/path/to/project', pkgWithWhitelist, null, null);
+    await generate('/path/to/project', pkgWithAllowlist, null, null);
     sandbox.assert.calledWith(
       archiver.compress,
       '/path/to/project',
@@ -136,7 +136,7 @@ describe('generate', () => {
   });
 
   it('creates the service file with a custom name if specified and "files" defined', async () => {
-    await generate('/path/to/project', pkgWithWhitelist, null, 'penguin');
+    await generate('/path/to/project', pkgWithAllowlist, null, 'penguin');
     sandbox.assert.calledWith(
       archiver.compress,
       '/path/to/project',