17 add exports field to package.json (#26)

* add exports field to package.json

* code refactoring

* update package version

* turn on declarationMap

* fix jest tests

* refactor release pipelines

* update readme, fix examples

* update tests imports

* code refactoring

* rename clients/http to clients/request and more code refactoring

* add support of http protocol for NodeHttpClient

* renaming, code refactoring

* code refactoring, ad typedoc package

* mark commands with internal attribute

* mark more exports as internal

* mark more exports as internal

* mark more exports as internal

* mark more exports as internal

* code refactoring

* fix some errors for generating docs

* code refactoring

* code refactoring

* code refactoring

* add required-first as sorting stratage for documentation

* code refactoring

Author: alex-titarenko

.github/workflows/pull-request.yml

@@ -31,4 +31,3 @@ jobs:
 
       - name: Test (Browsers)
         run: npm run test:browsers
-

.gitignore

@@ -5,3 +5,10 @@ node_modules
 
 # Distribution folder
 dist/
+
+# npm pack
+package/
+*.tgz
+
+# typedoc
+docs/

README.md

@@ -1,30 +1,33 @@
 # Git-Essentials
 A collection of essential Git commands for your browser and Node.js.
 
-# Usage Examples
+## Usage Examples
 
-## Node.js
+### Node.js
 ```typescript
 import fs from 'fs/promises'
-import { clone, HttpClients } from 'git-essentials'
+import { clone } from 'git-essentials'
+import { makeNodeHttpClient } from 'git-essentials/clients/request/NodeHttpClient'
 
-const http = HttpClients.makeNodeHttpClient()
+const http = makeNodeHttpClient()
 const dir = 'repos/Welcome'
 const url = 'https://github.com/NotesHubApp/Welcome.git'
 
 await clone({ fs, http, dir, url })
 ```
 
-## Browser
+### Browser
 ```typescript
-import { clone, FsClients, HttpClients } from 'git-essentials'
+import { clone } from 'git-essentials'
+import { InMemoryFsClient } from 'git-essentials/clients/fs/InMemoryFsClient'
+import { makeWebHttpClient } from 'git-essentials/clients/request/WebHttpClient'
 
 const corsProxyUrlTransformer = (originalUrl: string) => {
   return `https://www.noteshub.app/api/cors-proxy.ts?url=${encodeURIComponent(originalUrl)}`
 }
 
-const fs = new FsClients.InMemoryFsClient()
-const http = HttpClients.makeWebHttpClient({ transformRequestUrl: corsProxyUrlTransformer })
+const fs = new InMemoryFsClient()
+const http = makeWebHttpClient({ transformRequestUrl: corsProxyUrlTransformer })
 const dir = 'repos/Welcome'
 const url = 'https://github.com/NotesHubApp/Welcome.git'
 

jest.config.ts

@@ -2,7 +2,15 @@ import type { Config } from 'jest'
 
 const config: Config = {
   preset: 'ts-jest',
-  testEnvironment: 'node'
+  testEnvironment: 'node',
+  modulePathIgnorePatterns: [
+    "dist"
+  ],
+  moduleNameMapper: {
+    '^git-essentials$': '<rootDir>/src',
+    '^git-essentials/(.+)$': '<rootDir>/src/$1',
+    '^src/(.+)$': '<rootDir>/src/$1'
+  },
 };
 
 export default config

karma.conf.ts

@@ -32,7 +32,7 @@ module.exports = (config: any) => {
       "**/*.ts": "karma-typescript"
     },
     karmaTypescriptConfig: {
-      exclude: ["node_modules"],
+      exclude: ["node_modules", "dist"],
       compilerOptions: {
         "target": "es6",
         "strict": true,
@@ -41,6 +41,10 @@ module.exports = (config: any) => {
         "noFallthroughCasesInSwitch": true,
         "resolveJsonModule": true,
         "esModuleInterop": true,
+        "baseUrl": ".",
+        "paths": {
+          "git-essentials": ["./src/index"]
+        }
       },
       bundlerOptions: {
         addNodeGlobals: true