Merge pull request #6 from mijailr/refactor-names-location

refactor(core): refactor types and main class name
mijailr · Aug 14, 2020 · ee94502 · ee94502
2 parents cec519e + 4c996f4
commit ee94502
Show file tree

Hide file tree

Showing 10 changed files with 18 additions and 14 deletions.
diff --git a/.releaserc.json b/.releaserc.json
@@ -7,10 +7,10 @@
         "preset": "angular",
         "releaseRules": [
           { "type": "docs", "scope": "README", "release": "patch" },
-          { "type": "ref", "release": "patch" },
+          { "type": "refactor", "release": "patch" },
+          { "type": "fix", "release": "patch" },
           { "type": "build", "release": "minor" },
-          { "type": "feat", "release": "minor" },
-          { "type": "fix", "release": "patch" }
+          { "type": "feat", "release": "minor" }
         ],
         "parserOpts": {
           "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES"]

diff --git a/src/api/TerraformCloudApi.ts → src/api/TerraformCloud.ts b/src/api/TerraformCloudApi.ts → src/api/TerraformCloud.ts
@@ -1,9 +1,9 @@
 import { AxiosInstance } from 'axios'
 import { EventEmitter } from 'events'
 import terraformCloudApiClient from './terraformCloudApiClient'
-import { Account, Plan, Run } from './types'
+import { Account, Plan, Run } from '../types'
 
-export default class TerraformCloudApi extends EventEmitter {
+export default class TerraformCloud extends EventEmitter {
   private readonly client: AxiosInstance
 
   constructor(apiKey: string) {

diff --git a/src/index.ts b/src/index.ts
@@ -1,3 +1,4 @@
-import TerraformCloudApi from './api/TerraformCloudApi'
+import TerraformCloud from './api/TerraformCloud'
+import { Account, Plan, Run } from './types'
 
-export { TerraformCloudApi }
+export { TerraformCloud, Account, Plan, Run }
diff --git a/src/api/types/Account.ts → src/types/Account.ts b/src/api/types/Account.ts → src/types/Account.ts
@@ -1,4 +1,4 @@
-import { TerraformCloudData, Links } from '../types/TerraformCloudData'
+import { TerraformCloudData, Links } from './TerraformCloudData'
 
 export type Account = TerraformCloudData<AccountAttributes> & {
   relationships: AccountRelationships

diff --git a/src/api/types/Plan.ts → src/types/Plan.ts b/src/api/types/Plan.ts → src/types/Plan.ts
diff --git a/src/api/types/Run.ts → src/types/Run.ts b/src/api/types/Run.ts → src/types/Run.ts
@@ -4,13 +4,13 @@ export type Run = TerraformCloudData<RunAttributes> & {
   relationships: RunRelationship
 }
 
-export interface RunRelationship {
+interface RunRelationship {
   plan: Relationship
   'created-by': Relationship
   'confirmed-by': Relationship
 }
 
-export interface RunAttributes {
+interface RunAttributes {
   'auto-apply': boolean
   'error-text': null | string
   'is-destroy': boolean

diff --git a/src/api/types/TerraformCloudData.ts → src/types/TerraformCloudData.ts b/src/api/types/TerraformCloudData.ts → src/types/TerraformCloudData.ts
diff --git a/src/api/types/index.ts → src/types/index.ts b/src/api/types/index.ts → src/types/index.ts
diff --git a/test/api/TerraformCloudApi.test.ts b/test/api/TerraformCloudApi.test.ts
@@ -1,9 +1,8 @@
 import nock from 'nock'
-import TerraformCloudApi from '../../src/api/TerraformCloudApi'
-import AccountMock from '../mocks/AccountMock'
-import RunMock from '../mocks/RunMock'
+import TerraformCloud from '../../src/api/TerraformCloud'
+import { AccountMock, RunMock } from '../mocks'
 
-const client = new TerraformCloudApi('any-key')
+const client = new TerraformCloud('any-key')
 
 describe('Api requests', () => {
   describe('Account', () => {

diff --git a/test/mocks/index.ts b/test/mocks/index.ts
@@ -0,0 +1,4 @@
+import AccountMock from './AccountMock'
+import RunMock from './RunMock'
+
+export { AccountMock, RunMock }