[TASK] update reference for js types

dmh · dmh · commit 287fa634e130 · 2024-07-15T16:13:17.000+03:00
diff --git a/jsconfig.json b/jsconfig.json
@@ -6,7 +6,7 @@
     "checkJs": true,
     "forceConsistentCasingInFileNames": true,
     "useUnknownInCatchVariables": false,
-    "moduleResolution": "node"
+    "moduleResolution": "bundler"
   },
   "include": ["lib/**/*", "bin/**/*"],
 }
diff --git a/lib/args/args.js b/lib/args/args.js
@@ -11,6 +11,7 @@ const commands = [
   'fetch',
   'fetchModules',
   'upload',
+  'cleanUpload',
   'validate',
   'lighthouse',
   'fields',
diff --git a/lib/args/debug-verbose.js b/lib/args/debug-verbose.js
@@ -1,12 +1,7 @@
-import * as TYPES from '../types/types.js' // eslint-disable-line
+/// <reference path="../types/types.js" />
 import chalk from 'chalk'
 import minimist from 'minimist' // eslint-disable-line
 
-/**
- * @ignore
- * @typedef {TYPES.LOCALDATA} LOCALDATA {@link LOCALDATA}
- */
-
 /**
  * #### show debug info
  * @memberof OPTIONS
diff --git a/lib/args/debug.js b/lib/args/debug.js
@@ -1,12 +1,7 @@
-import * as TYPES from '../types/types.js' // eslint-disable-line
+/// <reference path="../types/types.js" />
 import chalk from 'chalk'
 import minimist from 'minimist' // eslint-disable-line
 
-/**
- * @ignore
- * @typedef {TYPES.LOCALDATA} LOCALDATA {@link LOCALDATA}
- */
-
 /**
  * #### show debug info
  * @memberof OPTIONS
diff --git a/lib/args/help.js b/lib/args/help.js
@@ -1,9 +1,5 @@
-import * as TYPES from '../types/types.js' // eslint-disable-line
+/// <reference path="../types/types.js" />
 
-/**
- * @ignore
- * @typedef {TYPES.LOCALDATA} LOCALDATA {@link LOCALDATA}
- */
 /**
  * @summary Show help information
  * @param {LOCALDATA} data - cli data
diff --git a/lib/cmd/info.js b/lib/cmd/info.js
@@ -1,11 +1,6 @@
-import * as TYPES from '../types/types.js' // eslint-disable-line
+/// <reference path="../types/types.js" />
 import chalk from 'chalk'
 
-/**
- * @ignore
- * @typedef {TYPES.LOCALDATA} LOCALDATA {@link LOCALDATA}
- */
-
 /**
  * #### theme info
  * @private
diff --git a/lib/cmd/init.js b/lib/cmd/init.js
@@ -1,4 +1,4 @@
-import * as TYPES from '../types/types.js' // eslint-disable-line
+/// <reference path="../types/types.js" />
 import { checkIsOnline, checkSshConnection } from '../utils/check.js'
 import { checkGithubTokenEnv, checkGithubToken, getGithubOrgs } from '../github/auth.js'
 import { githubRepoFromTemplatePrompts, localRepoFromTemplatePrompts, initType } from './init/prompts.js'
@@ -10,11 +10,6 @@ import { gitCloneDepth1, gitInit, gitAddAll, gitCommit } from '../git/git.js'
 import { parseJson, removePath, writeJson } from '../utils/fs.js'
 import chalk from 'chalk'
 
-/**
- * @ignore
- * @typedef {TYPES.LOCALDATA} LOCALDATA {@link LOCALDATA}
- */
-
 /**
  * #### Create a new GitHub repo based on a GitHub hosted template
  * @param {LOCALDATA} data - local data
diff --git a/lib/cmd/init/prompts.js b/lib/cmd/init/prompts.js
@@ -1,13 +1,8 @@
-import * as TYPES from '../../types/types.js' // eslint-disable-line
+/// <reference path="../../types/types.js" />
 import select from '@inquirer/select'
 import input from '@inquirer/input'
 import confirm from '@inquirer/confirm'
 
-/**
-* @ignore
-* @typedef {TYPES.LOCALDATA} LOCALDATA {@link LOCALDATA}
-*/
-
 /**
  * #### select what to initialize
  * @async
diff --git a/lib/git/git.js b/lib/git/git.js
@@ -1,15 +1,8 @@
-import * as TYPES from '../types/types.js' // eslint-disable-line
+/// <reference path="../types/types.js" />
 import gitUrlParse from 'git-url-parse'
 import ora from 'ora'
 import { $ } from 'execa'
 
-/**
- * @ignore
- * @typedef {TYPES.GIT_DATA} GIT_DATA {@link GIT_DATA}
- * @typedef {TYPES.LOCALDATA} LOCALDATA {@link LOCALDATA}
- * @typedef {TYPES.COMMIT_MESSAGE} COMMIT_MESSAGE {@link COMMIT_MESSAGE}
- */
-
 /**
  * #### Check is Git Repo
  * @async
diff --git a/lib/github/auth.js b/lib/github/auth.js
@@ -1,13 +1,8 @@
-import * as TYPES from '../types/types.js' // eslint-disable-line
+/// <reference path="../types/types.js" />
 import { request } from '@octokit/request'
 import chalk from 'chalk'
 import ora from 'ora'
 
-/**
-* @ignore
-* @typedef {TYPES.LOCALDATA} LOCALDATA {@link LOCALDATA}
-*/
-
 /**
  * #### check github token is set in env
  * @memberof GITHUB
diff --git a/lib/github/commit.js b/lib/github/commit.js
@@ -1,13 +1,8 @@
-import * as TYPES from '../types/types.js' // eslint-disable-line
+/// <reference path="../types/types.js" />
 import { request } from '@octokit/request'
 import chalk from 'chalk'
 import ora from 'ora'
 
-/**
-* @ignore
-* @typedef {TYPES.LOCALDATA} LOCALDATA {@link LOCALDATA}
-*/
-
 /**
  * #### update and commit file in the repository
  * @async
diff --git a/lib/github/repo.js b/lib/github/repo.js
@@ -1,15 +1,8 @@
-import * as TYPES from '../types/types.js' // eslint-disable-line
+/// <reference path="../types/types.js" />
 import { request } from '@octokit/request'
 import chalk from 'chalk'
 import ora from 'ora'
 
-/**
-* @ignore
-* @typedef {TYPES.LOCALDATA} LOCALDATA {@link LOCALDATA}
-* @typedef {TYPES.GITHUB_REPO_SETTINGS} GITHUB_REPO_SETTINGS {@link GITHUB_REPO_SETTINGS}
-* @typedef {TYPES.GITHUB_BRANCH_PROTECTION_SETTINGS} GITHUB_BRANCH_PROTECTION_SETTINGS {@link GITHUB_BRANCH_PROTECTION_SETTINGS}
-*/
-
 /**
  * #### create a repository using a template
  * @async
@@ -57,7 +50,7 @@ async function createGithubRepoWithTemplate (data) {
  * @async
  * @memberof GITHUB
  * @param {LOCALDATA} data - data object
- * @param {TYPES.GITHUB_REPO_SETTINGS} repoSettings - repository settings
+ * @param {GITHUB_REPO_SETTINGS} repoSettings - repository settings
  * @returns undefined
  */
 async function updateGithubRepoSettings (data, repoSettings) {
diff --git a/lib/github/secrets.js b/lib/github/secrets.js
@@ -1,14 +1,9 @@
-import * as TYPES from '../types/types.js' // eslint-disable-line
+/// <reference path="../types/types.js" />
 import { request } from '@octokit/request'
 import chalk from 'chalk'
 import ora from 'ora'
 import _sodium from 'libsodium-wrappers'
 
-/**
-* @ignore
-* @typedef {TYPES.LOCALDATA} LOCALDATA {@link LOCALDATA}
-*/
-
 /**
  * #### add repository secrets
  * @async
diff --git a/lib/init.js b/lib/init.js
@@ -1,4 +1,4 @@
-import * as TYPES from './types/types.js' // eslint-disable-line
+/// <reference path="./types/types.js" />
 import { parseArgs } from './args/args.js'
 import { parseCliPackageJson } from './utils/fs.js'
 import {
@@ -18,7 +18,7 @@ import { onExit } from 'signal-exit'
 import dotenv from 'dotenv'
 import { addUserRootDotEnvFileIfNotExists } from './utils/env.js'
 await addUserRootDotEnvFileIfNotExists()
-dotenv.config({ path: [`${process.env.HOME}/.rh/.env.root`, '.env'] })
+dotenv.config({ override: true, path: [`${process.env.HOME}/.rh/.env.root`, '.env'] })
 
 // handle exit signals properly
 // handle ctrl+c
@@ -37,12 +37,6 @@ await checkIfBinExists('git')
 const cliPackageJson = await parseCliPackageJson()
 await checkNode(cliPackageJson)
 
-/**
- * @ignore
- * @typedef {TYPES.LOCALDATA} LOCALDATA {@link LOCALDATA}
- * @typedef {TYPES.CLI_PACKAGE_JSON} CLI_PACKAGE_JSON {@link CLI_PACKAGE_JSON}
- */
-
 // parse args
 const args = parseArgs()
 // save local data
@@ -92,6 +86,12 @@ async function cliInit () {
         checkCliToThemeCompatibility(data, cliPackageJson)
         await import('@resultify/hubspot-cms-lib/upload')
         break
+      case 'cleanUpload':
+        // clean and upload files to HubSpot
+        checkIsHubSpotCmsTheme(data)
+        checkCliToThemeCompatibility(data, cliPackageJson)
+        await import('@resultify/hubspot-cms-lib/cleanUpload')
+        break
       case 'fetch':
         // fetch files from HubSpot
         checkIsHubSpotCmsTheme(data)
diff --git a/lib/localdata.js b/lib/localdata.js
@@ -1,18 +1,10 @@
-import * as TYPES from './types/types.js' // eslint-disable-line
+/// <reference path="./types/types.js" />
 import path from 'node:path'
 import dotenv from 'dotenv'
 import { isFileDirExists, parseJson } from './utils/fs.js'
 import { execa } from 'execa'
 import { gitData } from './git/git.js'
 
-/**
- * @ignore
- * @typedef {TYPES.LOCALDATA} LOCALDATA {@link LOCALDATA}
- * @typedef {TYPES.THEME_JSON} THEME_JSON {@link THEME_JSON}
- * @typedef {TYPES.THEME_PACKAGE_JSON} THEME_PACKAGE_JSON {@link THEME_PACKAGE_JSON}
- * @typedef {TYPES.CLI_PACKAGE_JSON} CLI_PACKAGE_JSON {@link CLI_PACKAGE_JSON}
- */
-
 const cwdPath = process.cwd()
 const sysNpm = await execa('npm', ['--version'])
 const sysGit = await execa('git', ['--version'])
diff --git a/lib/types/index.d.ts b/lib/types/index.d.ts
diff --git a/lib/types/types.js b/lib/types/types.js
@@ -157,5 +157,3 @@
  * @property {GITHUB_REPO_FROM_TEMPLATE_PROMPT_DATA} [prompts.githubRepoFromTmpl] - github repo from template prompts data
  * @property {LOCAL_REPO_FROM_TEMPLATE_PROMPT_DATA} [prompts.localRepoFromTmpl] - local repo from template prompts data
  */
-
-export default {}
diff --git a/lib/utils/check.js b/lib/utils/check.js
@@ -1,17 +1,11 @@
-import * as TYPES from '../types/types.js' // eslint-disable-line
+/// <reference path="../types/types.js" />
 import semver from 'semver'
 import { $ } from 'execa'
 import isOnline from 'is-online'
 import chalk from 'chalk'
 import * as git from '../git/git.js'
 import ora from 'ora'
 
-/**
- * @ignore
- * @typedef {TYPES.CLI_PACKAGE_JSON} CLI_PACKAGE_JSON {@link CLI_PACKAGE_JSON}
- * @typedef {TYPES.LOCALDATA} LOCALDATA {@link LOCALDATA}
- */
-
 /**
  * #### Check node version
  * Will throw an error if node version is wrong
diff --git a/lib/utils/fs.js b/lib/utils/fs.js
@@ -1,15 +1,10 @@
-import * as TYPES from '../types/types.js' // eslint-disable-line
+/// <reference path="../types/types.js" />
 import fsPromises from 'node:fs/promises'
 import path from 'node:path'
 import url from 'node:url'
 import { createRequire } from 'module'
 const require = createRequire(import.meta.url)
 
-/**
- * @ignore
- * @typedef {TYPES.CLI_PACKAGE_JSON} CLI_PACKAGE_JSON {@link CLI_PACKAGE_JSON}
- */
-
 /**
  * #### check if file/dir exists
  * @async

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`"checkJs": true,`
`7`	`7`	`"forceConsistentCasingInFileNames": true,`
`8`	`8`	`"useUnknownInCatchVariables": false,`
`9`		`- "moduleResolution": "node"`
	`9`	`+ "moduleResolution": "bundler"`
`10`	`10`	`},`
`11`	`11`	`"include": ["lib/*/", "bin/*/"],`
`12`	`12`	`}`