Merge pull request #2 from JumpCutter/dk949/npmify

Dreiparrent · web-flow · commit bdcc6a835b4d · 2021-10-26T23:50:56.000+01:00
Npmify
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -6,43 +6,11 @@ on:
       - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
 
 jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Read .nvmrc
-        run: echo ::set-output name=NVMRC::$(cat .nvmrc)
-        id: nvm
-
-      - name: Setup Node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '${{ steps.nvm.outputs.NVMRC }}'
-
-      - name: Install
-        run: |
-          yarn install
-
-      - name: Build
-        run: yarn release
-
-      - name: Artifact
-        uses: actions/upload-artifact@v2
-        with:
-          name: ubuntu-latest
-          path: dist
-
-
   build:
-    needs: test
     strategy:
       fail-fast: true
-      matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
       max-parallel: 3
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -61,12 +29,10 @@ jobs:
           yarn install
 
       - name: Build
-        if: startsWith(matrix.os, 'macos')
         run: |
           yarn release
 
       - name: Get Change
-        if: startsWith(matrix.os, 'ubuntu')
         id: changes
         run: |
           echo "# ${{ github.ref }}" > changes.txt
@@ -86,7 +52,6 @@ jobs:
           echo ::set-output name=log::$(cat changes.txt)
 
       - name: Upload change
-        if: startsWith(matrix.os, 'ubuntu')
         uses: actions/upload-artifact@v2
         with:
           name: changes
@@ -95,8 +60,8 @@ jobs:
       - name: Artifact
         uses: actions/upload-artifact@v2
         with:
-          name: ${{ matrix.os }}
-          path: dist
+          name: package
+          path: package
 
   release:
     needs: build
@@ -118,14 +83,11 @@ jobs:
         id: create_release
         uses: actions/create-release@v1
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           tag_name: ${{ github.ref }}
           release_name: Release ${{ github.ref }}
-          # body: ${{ steps.changes.outputs.log }}
           body_path: changes.txt
-          # body: ${{ needs.build.outputs.log }}
-          # echo ::set-env name=FOO::$(echo -n "hello world")
           draft: false
           prerelease: false
 
@@ -137,58 +99,24 @@ jobs:
   upload:
     needs: release
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: true
-      matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-      max-parallel: 3
     steps:
       - uses: actions/download-artifact@v2
         with:
-          name: ${{ matrix.os }}
+          name: package
           path: ProjectExportAPI
 
       - name: list path
-        if: startsWith(matrix.os, 'windows')
-        run: dir ProjectExportAPI
-
-      - name: Compress folder
-        if: startsWith(matrix.os, 'windows')
-        run: cd ProjectExportAPI && 7za a ../ProjectExportAPI.zip
+        run: ls -l ProjectExportAPI
 
       - name: Compress folder
-        if: startsWith(matrix.os, 'windows') != true
-        run: zip -r ProjectExportAPI.zip ProjectExportAPI/*
-
-      - name: Upload Linux Asset
-        if: startsWith(matrix.os, 'ubuntu')
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ needs.release.outputs.upload_url }}
-          asset_path: ProjectExportAPI.zip
-          asset_name: ProjectExportAPI-linux.zip
-          asset_content_type: application/zip
-
-      - name: Upload Mac Asset
-        if: startsWith(matrix.os, 'macos')
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ needs.release.outputs.upload_url }}
-          asset_path: ProjectExportAPI.zip
-          asset_name: ProjectExportAPI-mac.zip
-          asset_content_type: application/zip
+        run: tar -cvzf ProjectExportAPI.tar.gz ProjectExportAPI
 
-      - name: Upload Windows Asset
-        if: startsWith(matrix.os, 'windows')
+      - name: Upload Asset
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ needs.release.outputs.upload_url }}
-          asset_path: ProjectExportAPI.zip
-          asset_name: ProjectExportAPI-windows.zip
+          asset_path: ProjectExportAPI.tar.gz
+          asset_name: ProjectExportAPI.tar.gz
           asset_content_type: application/zip
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@ dist
 node_modules
 yarn-error.log
 test/test.*
+package
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Change Log
 
+## [0.0.3](https://github.com/JumpCutter/JC-ProjectExportAPI/compare/v0.0.2...v0.0.3) (2021-10-18)
+### Changes
+- __release__: Third time's the charm
+
+## [0.0.2](https://github.com/JumpCutter/JC-ProjectExportAPI/compare/v0.0.1...v0.0.2) (2021-10-13)
+### Changes
+- __release__: CI!!!
+
 ## [0.0.1](https://github.com/JumpCutter/JC-ProjectExportAPI/compare/v0.0.0...v0.0.1) (2021-10-04)
 ### Changes
 - __release__: initial release, basic test
diff --git a/package.json b/package.json
@@ -2,22 +2,37 @@
   "name": "JC-ProjectExportAPI",
   "version": "0.0.1",
   "description": "Project export API",
-  "main": "dist/test.js",
+  "main": "dist/index.js",
   "author": "dk949",
   "license": "MIT",
-  "private": true,
+  "private": false,
   "scripts": {
     "cp": "node .github/cp.js",
     "mkdir": "node .github/mkdir.js",
-    "build": "yarn run tsc",
-    "release": "yarn build && yarn cp ./src/ProjectExport.d.ts dist",
+    "build": "yarn tsc",
+    "release": "yarn build && yarn cp ./src/project.d.ts package/dist && yarn cp ./src/index.d.ts package/dist && yarn cp ./package.json package/",
     "test": "mocha"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JumpCutter/JC-ProjectExportAPI"
+  },
+  "keywords": [
+    "JumpCutter",
+    "Editor"
+  ],
+  "bugs": {
+    "url": "https://github.com/JumpCutter/JC-ProjectExportAPI/issues"
+  },
+  "homepage": "https://github.com/JumpCutter/JC-ProjectExportAPI#readme",
+  "files": [
+    "dist/**/*"
+  ],
   "dependencies": {
-    "edl_composer": "^1.0.3",
-    "typescript": "^4.4.3"
+    "edl_composer": "^1.0.3"
   },
   "devDependencies": {
+    "typescript": "^4.3.4",
     "@types/mocha": "^9.0.0",
     "@types/node": "^16.10.2",
     "mocha": "^9.1.2",
diff --git a/src/index.d.ts b/src/index.d.ts
@@ -0,0 +1,11 @@
+import * as Project from "./project";
+export {Project};
+export abstract class Generator{
+    constructor(project: Project.Project)
+    generate(): string;
+}
+
+export class ResolveEDL extends Generator{}
+export class VegasEDL extends Generator{}
+export class FCPXML extends Generator{}
+export class XML extends Generator{}
diff --git a/src/index.ts b/src/index.ts
diff --git a/src/project.d.ts b/src/project.d.ts
@@ -1,6 +1,6 @@
 export interface Project {
     outFile: string;
-    resolution?: null;
+    resolution: string | null;
     frameRate: number;
     layers?: Layers | null;
 }
diff --git a/test/index.spec.ts b/test/index.spec.ts
@@ -1,13 +1,8 @@
-import {VegasEDL} from "../src/vegasEDL/genVegasEDL"
-import {ResolveEDL} from "../src/EDL/genEDL"
-import {FCPXML} from "../src/FCPXML/genFCPXML"
-import {XML} from "../src/XML/genXML"
-
+import * as PEAPI from "../src/index";
 import fs from "fs";
 import path from "path";
 
 
-
 let generators = {};
 
 
@@ -18,7 +13,7 @@ project["layers"][0][0]["sourceFile"] = "../JC-examples/yoga.mp4"
 describe("generating vegasEDL for importing into Sony Vegas Pro", () => {
     it("should create a generator object that takes project as an argument", () => {
         let tmp = project;
-        generators["VegasEDL"] = (new VegasEDL(tmp));
+        generators["VegasEDL"] = (new PEAPI.VegasEDL(tmp));
     });
     it("generate a string representing a project in the EDL format Sony vegas supports", () => {
         fs.writeFileSync(path.join(__dirname, "./test.txt"), generators["VegasEDL"].generate());
@@ -28,7 +23,7 @@ describe("generating vegasEDL for importing into Sony Vegas Pro", () => {
 describe("generating EDL for importing into DaVinci Resolve", () => {
     it("should create a generator object that takes project as an argument", () => {
         let tmp = project;
-        generators["ResolveEDL"] = (new ResolveEDL(tmp));
+        generators["ResolveEDL"] = (new PEAPI.ResolveEDL(tmp));
     });
     it("generate a string representing a project in the EDL format", () => {
         fs.writeFileSync(path.join(__dirname, "./test.edl"), generators["ResolveEDL"].generate());
@@ -39,7 +34,7 @@ describe("generating EDL for importing into DaVinci Resolve", () => {
 describe("generating FCPXML for importing into FinalCut Pro", () => {
     it("should create a generator object that takes project as an argument", () => {
         let tmp = project;
-        generators["FCPXML"] = (new FCPXML(tmp));
+        generators["FCPXML"] = (new PEAPI.FCPXML(tmp));
     });
     it("generate a string representing a project in the FCPXML format", () => {
         fs.writeFileSync(path.join(__dirname, "./test.fcpxml"), generators["FCPXML"].generate());
@@ -51,7 +46,7 @@ describe("generating FCPXML for importing into FinalCut Pro", () => {
 describe("generating XML for importing into Premiere Pro", () => {
     it("should create a generator object that takes project as an argument", () => {
         let tmp = project;
-        generators["XML"] = (new XML(tmp));
+        generators["XML"] = (new PEAPI.XML(tmp));
     });
     it("generate a string representing a project in the EDL format Sony vegas supports", () => {
         fs.writeFileSync(path.join(__dirname, "./test.xml"), generators["XML"].generate());
diff --git a/tsconfig.json b/tsconfig.json
@@ -17,7 +17,7 @@
     "allowJs": true,
     "jsx": "react",
     "sourceMap": true,
-    "outDir": "./dist",
+    "outDir": "./package/dist",
     "strict": true,
     "noImplicitAny": false,
     "esModuleInterop": true,
@@ -30,7 +30,7 @@
   "exclude": [
     "node_modules",
     "test",
-    "dist"
+    "package"
   ],
   "ts-node": {
     "files": true
diff --git a/yarn.lock b/yarn.lock
@@ -40,9 +40,9 @@
   integrity sha512-scN0hAWyLVAvLR9AyW7HoFF5sJZglyBsbPuHO4fv7JRvfmPBMfp1ozWqOf/e4wwPNxezBZXRfWzMb6iFLgEVRA==
 
 "@types/node@^16.10.2":
-  version "16.10.2"
-  resolved "https://registry.yarnpkg.com/@types/node/-/node-16.10.2.tgz#5764ca9aa94470adb4e1185fe2e9f19458992b2e"
-  integrity sha512-zCclL4/rx+W5SQTzFs9wyvvyCwoK9QtBpratqz2IYJ3O8Umrn0m3nsTv0wQBk9sRGpvUe9CwPDrQFB10f1FIjQ==
+  version "16.10.3"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-16.10.3.tgz#7a8f2838603ea314d1d22bb3171d899e15c57bd5"
+  integrity sha512-ho3Ruq+fFnBrZhUYI46n/bV2GjwzSkwuT4dTf0GkuNFmnb8nq4ny2z9JEVemFi6bdEJanHLlYfy9c6FN9B9McQ==
 
 "@ungap/promise-all-settled@1.1.2":
   version "1.1.2"
@@ -569,7 +569,7 @@ ts-node@^10.2.1:
     make-error "^1.1.1"
     yn "3.1.1"
 
-typescript@^4.4.3:
+typescript@^4.3.4:
   version "4.4.3"
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.4.3.tgz#bdc5407caa2b109efd4f82fe130656f977a29324"
   integrity sha512-4xfscpisVgqqDfPaJo5vkd+Qd/ItkoagnHpufr+i2QCHBsNYp+G7UAoyFl8aPtx879u38wPV65rZ8qbGZijalA==

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`export interface Project {`
`2`	`2`	`outFile: string;`
`3`		`- resolution?: null;`
	`3`	`+ resolution: string \| null;`
`4`	`4`	`frameRate: number;`
`5`	`5`	`layers?: Layers \| null;`
`6`	`6`	`}`