feat(cli): generate datasource json with '.config.json` extension

Workaround for microsoft/TypeScript#34761
loopbackio · Nov 5, 2019 · 59a1093 · 59a1093
1 parent 7db846b
commit 59a1093
Show file tree

Hide file tree

Showing 29 changed files with 62 additions and 61 deletions.
diff --git a/docs/site/DataSource-generator.md b/docs/site/DataSource-generator.md
@@ -51,7 +51,7 @@ Once all the prompts have been answered, the CLI will do the following:
 - Install `@loopback/repository` and the connector package (if it's not a custom
   connector).
 - Create a file with the connector configuration as follows:
-  `/src/datasources/${dataSource.dataSourceName}.datasource.json`
+  `/src/datasources/${dataSource.dataSourceName}.config.json`
 - Create a DataSource class which recieves the connector config using
   [Dependency Injection](Dependency-injection.md) as follows:
   `/src/datasources/${dataSource.dataSourceName}.datasource.ts`

diff --git a/docs/site/DataSources.md b/docs/site/DataSources.md
@@ -20,7 +20,7 @@ It is recommended to use the [`lb4 datasource` command](DataSource-generator.md)
 provided by the CLI to generate a DataSource. The CLI will prompt for all
 necessary connector information and create the following files:
 
-- `${dataSource.dataSourceName}.datasource.json` containing the connector
+- `${dataSource.dataSourceName}.config.json` containing the connector
   configuration
 - `${dataSource.dataSourceName}.datasource.ts` containing a class extending
   `juggler.DataSource`. This class can be used to override the default
@@ -37,7 +37,7 @@ Example DataSource Class:
 ```ts
 import {inject} from '@loopback/core';
 import {juggler} from '@loopback/repository';
-import * as config from './db.datasource.json';
+import * as config from './db.config.json';
 
 export class DbDataSource extends juggler.DataSource {
   static dataSourceName = 'db';

diff --git a/docs/site/Inside-Loopback-Application.md b/docs/site/Inside-Loopback-Application.md
@@ -258,9 +258,9 @@ We need appropriate drivers to connect with the backend datasources.
 > to provide easy to use CRUD operations and connection configurations.
 
 In the example,
-[Redis datasource definition](https://github.com/strongloop/loopback4-example-shopping/blob/master/packages/shopping/src/datasources/redis.datasource.json)
+[Redis datasource definition](https://github.com/strongloop/loopback4-example-shopping/blob/master/packages/shopping/src/datasources/redis.config.json)
 uses the LoopBack `kv-redis` connector and
-[MongoDB datasource definition](https://github.com/strongloop/loopback4-example-shopping/blob/master/packages/shopping/src/datasources/mongo.datasource.json)
+[MongoDB datasource definition](https://github.com/strongloop/loopback4-example-shopping/blob/master/packages/shopping/src/datasources/mongo.config.json)
 uses the LoopBack `mongodb` connector.
 
 ## Application startup

diff --git a/docs/site/Repositories.md b/docs/site/Repositories.md
@@ -312,7 +312,7 @@ better flexibility, we split the datasource definition into two files. The json
 file captures the configuration properties and it can be possibly overridden by
 dependency injection.
 
-1. redis.datasource.json
+1. redis.config.json
 
 ```json
 {
@@ -328,14 +328,14 @@ dependency injection.
 2. redis.datasource.ts
 
 The class uses a configuration object to set up a datasource for the Redis
-instance. By default, the configuration is loaded from `redis.datasource.json`.
+instance. By default, the configuration is loaded from `redis.config.json`.
 We can override it by binding a new object to `datasources.config.redis` for a
 context.
 
 ```ts
 import {inject} from '@loopback/core';
 import {juggler, AnyObject} from '@loopback/repository';
-import * as config from './redis.datasource.json';
+import * as config from './redis.config.json';
 
 export class RedisDataSource extends juggler.DataSource {
   static dataSourceName = 'redis';

diff --git a/docs/site/Testing-your-application.md b/docs/site/Testing-your-application.md
@@ -740,7 +740,7 @@ instance:
 
 ```ts
 import {merge} from 'lodash';
-import * as GEO_CODER_CONFIG from '../datasources/geo.datasource.json';
+import * as GEO_CODER_CONFIG from '../datasources/geo.config.json';
 
 function givenGeoService() {
   const config = merge({}, GEO_CODER_CONFIG, {

diff --git a/docs/site/deployment/Deploying-to-IBM-Cloud.md b/docs/site/deployment/Deploying-to-IBM-Cloud.md
@@ -69,7 +69,7 @@ Cloudant connector, so data is persisted.
 
 ### Step 3: Updating your DataSource
 
-Update `db.datasource.json` to use the Cloudant connector. The value for the
+Update `db.config.json` to use the Cloudant connector. The value for the
 `url` property is just a placeholder and does not need to have the correct
 credential because we will be binding the app with the Cloudant service once
 it's pushed to IBM Cloud.
@@ -106,7 +106,7 @@ $ npm i loopback-connector-cloudant
    import {TodoListApplication} from './application';
    import {ApplicationConfig} from '@loopback/core';
    // --------- ADD THIS SNIPPET ---------
-   const datasourceDb = require('./datasources/db.datasource.json');
+   const datasourceDb = require('./datasources/db.config.json');
    const cfenv = require('cfenv');
    const appEnv = cfenv.getAppEnv();
    // --------- ADD THIS SNIPPET ---------

diff --git a/docs/site/tutorials/soap-calculator/soap-calculator-tutorial-add-datasource.md b/docs/site/tutorials/soap-calculator/soap-calculator-tutorial-add-datasource.md
@@ -67,7 +67,7 @@ JSON configuration file and a .ts file with the Datasource name and added an
 entry inside the index.ts file.
 
 ```sh
-   create src/datasources/calculator.datasource.json
+   create src/datasources/calculator.config.json
    create src/datasources/calculator.datasource.ts
    update src/datasources/index.ts
 
@@ -103,10 +103,10 @@ bind the Node.js method _Multiply_.
  }
 ```
 
-Edit the file `src/datasources/calculator.datasource.json` and add the following
+Edit the file `src/datasources/calculator.config.json` and add the following
 configuration after the `remoteEnabled: true,` property as follows:
 
-{% include code-caption.html content="src/datasources/calculator.datasource.json" %}
+{% include code-caption.html content="src/datasources/calculator.config.json" %}
 
 ```ts
 "operations": {

diff --git a/docs/site/tutorials/todo/todo-tutorial-datasource.md b/docs/site/tutorials/todo/todo-tutorial-datasource.md
@@ -39,7 +39,7 @@ lb4 datasource
 ? window.localStorage key to use for persistence (browser only):
 ? Full path to file for persistence (server only): ./data/db.json
 
-  create src/datasources/db.datasource.json
+  create src/datasources/db.config.json
   create src/datasources/db.datasource.ts
   update src/datasources/index.ts
 

diff --git a/docs/site/tutorials/todo/todo-tutorial-geocoding-service.md b/docs/site/tutorials/todo/todo-tutorial-geocoding-service.md
@@ -47,7 +47,7 @@ $ lb4 datasource
 ? Default options for the request:
 ? An array of operation templates:
 ? Use default CRUD mapping: No
-   create src/datasources/geocoder.datasource.json
+   create src/datasources/geocoder.config.json
    create src/datasources/geocoder.datasource.ts
  # npm will install dependencies now
     update src/datasources/index.ts
@@ -59,7 +59,7 @@ Edit the newly created datasource configuration to configure Geocoder API
 endpoints. Configuration options provided by REST Connector are described in our
 docs here: [REST connector](/doc/en/lb3/REST-connector.html).
 
-{% include code-caption.html content="/src/datasources/geocoder.datasource.json" %}
+{% include code-caption.html content="/src/datasources/geocoder.config.json" %}
 
 ```json
 {

diff --git a/...sition/src/datasources/ds.datasource.json → ...omposition/src/datasources/ds.config.json b/...sition/src/datasources/ds.datasource.json → ...omposition/src/datasources/ds.config.json
diff --git a/examples/express-composition/src/datasources/ds.datasource.ts b/examples/express-composition/src/datasources/ds.datasource.ts
@@ -3,9 +3,9 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {inject} from '@loopback/core';
-import {juggler} from '@loopback/repository';
-import * as config from './ds.datasource.json';
+import { inject } from '@loopback/core';
+import { juggler } from '@loopback/repository';
+import * as config from './ds.config.json';
 
 export class DsDataSource extends juggler.DataSource {
   static dataSourceName = 'ds';

diff --git a/...rc/datasources/calculator.datasource.json → ...or/src/datasources/calculator.config.json b/...rc/datasources/calculator.datasource.json → ...or/src/datasources/calculator.config.json
diff --git a/examples/soap-calculator/src/datasources/calculator.datasource.ts b/examples/soap-calculator/src/datasources/calculator.datasource.ts
@@ -3,9 +3,9 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {inject} from '@loopback/core';
-import {juggler} from '@loopback/repository';
-import * as config from './calculator.datasource.json';
+import { inject } from '@loopback/core';
+import { juggler } from '@loopback/repository';
+import * as config from './calculator.config.json';
 
 export class CalculatorDataSource extends juggler.DataSource {
   static dataSourceName = 'calculator';

diff --git a/...o-list/src/datasources/db.datasource.json → .../todo-list/src/datasources/db.config.json b/...o-list/src/datasources/db.datasource.json → .../todo-list/src/datasources/db.config.json
diff --git a/examples/todo-list/src/datasources/db.datasource.ts b/examples/todo-list/src/datasources/db.datasource.ts
@@ -3,9 +3,9 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {inject} from '@loopback/core';
-import {juggler} from '@loopback/repository';
-import * as config from './db.datasource.json';
+import { inject } from '@loopback/core';
+import { juggler } from '@loopback/repository';
+import * as config from './db.config.json';
 
 export class DbDataSource extends juggler.DataSource {
   static dataSourceName = 'db';

diff --git a/examples/todo/src/__tests__/helpers.ts b/examples/todo/src/__tests__/helpers.ts
@@ -3,12 +3,12 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {HttpCachingProxy} from '@loopback/http-caching-proxy';
-import {merge} from 'lodash';
+import { HttpCachingProxy } from '@loopback/http-caching-proxy';
+import { merge } from 'lodash';
 import * as path from 'path';
-import * as GEO_CODER_CONFIG from '../datasources/geocoder.datasource.json';
-import {Todo} from '../models/index';
-import {GeocoderService, GeoPoint} from '../services/geocoder.service';
+import * as GEO_CODER_CONFIG from '../datasources/geocoder.config.json';
+import { Todo } from '../models/index';
+import { GeocoderService, GeoPoint } from '../services/geocoder.service';
 
 /*
  ==============================================================================
@@ -63,7 +63,7 @@ export function getProxiedGeoCoderConfig(proxy: HttpCachingProxy) {
   });
 }
 
-export {HttpCachingProxy};
+export { HttpCachingProxy };
 export async function givenCachingProxy() {
   const proxy = new HttpCachingProxy({
     cachePath: path.resolve(__dirname, '.http-cache'),

diff --git a/...s/todo/src/datasources/db.datasource.json → examples/todo/src/datasources/db.config.json b/...s/todo/src/datasources/db.datasource.json → examples/todo/src/datasources/db.config.json
diff --git a/examples/todo/src/datasources/db.datasource.ts b/examples/todo/src/datasources/db.datasource.ts
@@ -3,9 +3,9 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {inject} from '@loopback/core';
-import {juggler} from '@loopback/repository';
-import * as config from './db.datasource.json';
+import { inject } from '@loopback/core';
+import { juggler } from '@loopback/repository';
+import * as config from './db.config.json';
 
 export class DbDataSource extends juggler.DataSource {
   static dataSourceName = 'db';

diff --git a/.../src/datasources/geocoder.datasource.json → ...todo/src/datasources/geocoder.config.json b/.../src/datasources/geocoder.datasource.json → ...todo/src/datasources/geocoder.config.json
diff --git a/examples/todo/src/datasources/geocoder.datasource.ts b/examples/todo/src/datasources/geocoder.datasource.ts
@@ -3,9 +3,9 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {inject} from '@loopback/core';
-import {juggler, AnyObject} from '@loopback/repository';
-import * as config from './geocoder.datasource.json';
+import { inject } from '@loopback/core';
+import { AnyObject, juggler } from '@loopback/repository';
+import * as config from './geocoder.config.json';
 
 export class GeocoderDataSource extends juggler.DataSource {
   static dataSourceName = 'geocoder';

diff --git a/packages/cli/generators/datasource/index.js b/packages/cli/generators/datasource/index.js
@@ -240,7 +240,7 @@ module.exports = class DataSourceGenerator extends ArtifactGenerator {
     this.artifactInfo.className = utils.toClassName(this.artifactInfo.name);
     this.artifactInfo.fileName = utils.toFileName(this.artifactInfo.name);
     // prettier-ignore
-    this.artifactInfo.jsonFileName = `${this.artifactInfo.fileName}.datasource.json`;
+    this.artifactInfo.jsonFileName = `${this.artifactInfo.fileName}.config.json`;
     // prettier-ignore
     this.artifactInfo.outFile = `${this.artifactInfo.fileName}.datasource.ts`;
 

diff --git a/packages/cli/lib/utils.js b/packages/cli/lib/utils.js
@@ -559,7 +559,7 @@ exports.getDataSourceName = function(datasourcesDir, dataSourceClass) {
 
 exports.dataSourceToJSONFileName = function(dataSourceClass) {
   return path.join(
-    toFileName(dataSourceClass.replace('Datasource', '')) + '.datasource.json',
+    toFileName(dataSourceClass.replace('Datasource', '')) + '.config.json',
   );
 };
 

diff --git a/packages/cli/snapshots/integration/generators/datasource.integration.snapshots.js b/packages/cli/snapshots/integration/generators/datasource.integration.snapshots.js
@@ -15,7 +15,7 @@ import {
   ValueOrPromise,
 } from '@loopback/core';
 import {juggler} from '@loopback/repository';
-import * as config from './ds.datasource.json';
+import * as config from './ds.config.json';
 
 @lifeCycleObserver('datasource')
 export class DsDataSource extends juggler.DataSource
@@ -56,7 +56,7 @@ import {
   ValueOrPromise,
 } from '@loopback/core';
 import {juggler} from '@loopback/repository';
-import * as config from './ds.datasource.json';
+import * as config from './ds.config.json';
 
 @lifeCycleObserver('datasource')
 export class DsDataSource extends juggler.DataSource
@@ -97,7 +97,7 @@ import {
   ValueOrPromise,
 } from '@loopback/core';
 import {juggler} from '@loopback/repository';
-import * as config from './ds.datasource.json';
+import * as config from './ds.config.json';
 
 @lifeCycleObserver('datasource')
 export class DsDataSource extends juggler.DataSource
@@ -138,7 +138,7 @@ import {
   ValueOrPromise,
 } from '@loopback/core';
 import {juggler} from '@loopback/repository';
-import * as config from './ds.datasource.json';
+import * as config from './ds.config.json';
 
 @lifeCycleObserver('datasource')
 export class DsDataSource extends juggler.DataSource
@@ -179,7 +179,7 @@ import {
   ValueOrPromise,
 } from '@loopback/core';
 import {juggler} from '@loopback/repository';
-import * as config from './ds.datasource.json';
+import * as config from './ds.config.json';
 
 @lifeCycleObserver('datasource')
 export class DsDataSource extends juggler.DataSource

diff --git a/packages/cli/test/fixtures/relation/index.js b/packages/cli/test/fixtures/relation/index.js
@@ -108,7 +108,7 @@ exports.SANDBOX_FILES = [
   },
   {
     path: DATASOURCE_APP_PATH,
-    file: 'dbkv.datasource.json',
+    file: 'dbkv.config.json',
     content: JSON.stringify({
       name: 'dbkv',
       connector: 'kv-redis',
@@ -121,15 +121,15 @@ exports.SANDBOX_FILES = [
   },
   {
     path: DATASOURCE_APP_PATH,
-    file: 'dbmem.datasource.json',
+    file: 'dbmem.config.json',
     content: JSON.stringify({
       name: 'dbmem',
       connector: 'memory',
     }),
   },
   {
     path: DATASOURCE_APP_PATH,
-    file: 'my-ds.datasource.json',
+    file: 'my-ds.config.json',
     content: JSON.stringify({
       name: 'MyDS',
       connector: 'memory',
@@ -142,15 +142,15 @@ exports.SANDBOX_FILES = [
   },
   {
     path: DATASOURCE_APP_PATH,
-    file: 'restdb.datasource.json',
+    file: 'restdb.config.json',
     content: JSON.stringify({
       name: 'restdb',
       connector: 'rest',
     }),
   },
   {
     path: DATASOURCE_APP_PATH,
-    file: 'sqlite3.datasource.json',
+    file: 'sqlite3.config.json',
     content: JSON.stringify({
       name: 'sqlite3',
       connector: 'loopback-connector-sqlite3',

diff --git a/packages/cli/test/fixtures/repository/index.js b/packages/cli/test/fixtures/repository/index.js
@@ -21,7 +21,7 @@ exports.SANDBOX_FILES = [
   },
   {
     path: DATASOURCE_APP_PATH,
-    file: 'dbkv.datasource.json',
+    file: 'dbkv.config.json',
     content: JSON.stringify({
       name: 'dbkv',
       connector: 'kv-redis',
@@ -34,15 +34,15 @@ exports.SANDBOX_FILES = [
   },
   {
     path: DATASOURCE_APP_PATH,
-    file: 'dbmem.datasource.json',
+    file: 'dbmem.config.json',
     content: JSON.stringify({
       name: 'dbmem',
       connector: 'memory',
     }),
   },
   {
     path: DATASOURCE_APP_PATH,
-    file: 'my-ds.datasource.json',
+    file: 'my-ds.config.json',
     content: JSON.stringify({
       name: 'MyDS',
       connector: 'memory',
@@ -55,15 +55,15 @@ exports.SANDBOX_FILES = [
   },
   {
     path: DATASOURCE_APP_PATH,
-    file: 'restdb.datasource.json',
+    file: 'restdb.config.json',
     content: JSON.stringify({
       name: 'restdb',
       connector: 'rest',
     }),
   },
   {
     path: DATASOURCE_APP_PATH,
-    file: 'sqlite3.datasource.json',
+    file: 'sqlite3.config.json',
     content: JSON.stringify({
       name: 'sqlite3',
       connector: 'loopback-connector-sqlite3',