Merge pull request #1 from DiFuks/prepare-to-publish

Prepare to publish

.github/README.md

@@ -0,0 +1 @@
+../packages/plugin/README.md

.github/workflows/build-and-publish.yml

@@ -0,0 +1,89 @@
+name: Build and Publish
+
+on: push
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./packages/plugin
+    env:
+      NPM_DIFUKS_TOKEN: ${{ secrets.NPM_DIFUKS_TOKEN }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.PERSONAL_TOKEN }}
+
+      # for yarn version check
+      - if: github.ref != 'refs/heads/main'
+        run: |
+          git fetch --unshallow origin main
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          cache: yarn
+          cache-dependency-path: yarn.lock
+
+      - name: Install modules
+        run: yarn
+
+      - name: Build plugin
+        run: yarn build
+
+      - name: Lint plugin
+        run: yarn lint
+
+      - name: Check packages versions
+        if: github.ref != 'refs/heads/main'
+        run: yarn version check
+
+      - name: Apply versions
+        if: github.ref == 'refs/heads/main'
+        run: yarn version apply
+
+      - name: Publish package
+        if: github.ref == 'refs/heads/main'
+        run: yarn npm publish --tolerate-republish
+
+      - uses: stefanzweifel/git-auto-commit-action@v5
+        if: github.ref == 'refs/heads/main'
+        with:
+          commit_message: |
+            ci: Release packages
+            
+            [skip ci]
+
+      - name: Get package version
+        if: github.ref == 'refs/heads/main'
+        id: package-version
+        uses: martinbeentjes/[email protected]
+        with:
+          path: packages/plugin
+
+      - uses: stefanzweifel/git-auto-commit-action@v5
+        if: github.ref == 'refs/heads/main'
+        with:
+          tagging_message: v${{ steps.package-version.outputs.current-version }}
+          commit_message: |
+            ci: Release packages
+            
+            [skip ci]
+
+      - name: Get pull request info
+        if: github.ref == 'refs/heads/main'
+        id: pull-request-info
+        uses: actions-ecosystem/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: ncipollo/release-action@v1
+        id: create-release
+        if: github.ref == 'refs/heads/main'
+        with:
+          skipIfReleaseExists: true
+          makeLatest: true
+          name: Release ${{ steps.package-version.outputs.current-version }}
+          body: ${{ steps.pull-request-info.outputs.body }}
+          tag: v${{ steps.package-version.outputs.current-version }}

.gitignore

@@ -1,5 +1,3 @@
-.idea
-
 .yarn/*
 !.yarn/patches
 !.yarn/plugins

.nvmrc

@@ -0,0 +1 @@
+v20.13.0

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+  "recommendations": [
+    "arcanis.vscode-zipfs"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "search.exclude": {
+    "**/.yarn": true,
+    "**/.pnp.*": true
+  },
+  "typescript.tsdk": ".yarn/sdks/typescript/lib",
+  "typescript.enablePromptUseWorkspaceTsdk": true
+}

.yarn/versions/420531ed.yml

@@ -0,0 +1,2 @@
+declined:
+  - ts-overrides-plugin

.yarnrc.yml

@@ -1,5 +1,21 @@
+enableGlobalCache: true
+
 nodeLinker: node-modules
 
+npmAuthToken: "${NPM_DIFUKS_TOKEN:-}"
+
+npmPublishAccess: public
+
+npmRegistryServer: "https://registry.npmjs.com/"
+
+packageExtensions:
+  eslint-module-utils@*:
+    dependencies:
+      eslint-import-resolver-typescript: 3.6.1
+  ts-patch@*:
+    peerDependencies:
+      typescript: "*"
+
 tsEnableAutoTypes: true
 
-yarnPath: .yarn/releases/yarn-4.0.2.cjs
+yarnPath: .yarn/releases/yarn-4.3.0.cjs

package.json

@@ -4,14 +4,18 @@
     "packages/*"
   ],
   "scripts": {
+    "lint:plugin": "yarn workspace ts-overrides-plugin lint",
     "build:plugin": "yarn workspace ts-overrides-plugin build",
     "watch:plugin": "yarn workspace ts-overrides-plugin watch",
-    "build:tspc": "yarn workspace example tspc",
+    "build:tspc": "yarn workspace example build:tspc",
     "build:ts-loader": "yarn workspace example build:ts-loader",
     "build:fork-ts": "yarn workspace example build:fork-ts",
-    "watch:tspc": "yarn workspace example tspc --watch",
-    "watch:ts-loader": "yarn workspace example build:ts-loader --watch",
-    "watch:fork-ts": "yarn workspace example build:fork-ts --watch"
+    "watch:tspc": "yarn workspace example watch:tspc",
+    "watch:ts-loader": "yarn workspace example watch:ts-loader",
+    "watch:fork-ts": "yarn workspace example watch:fork-ts"
   },
-  "packageManager": "[email protected]"
+  "devDependencies": {
+    "typescript": "5.5.1-rc"
+  },
+  "packageManager": "[email protected]"
 }

packages/example/README.md

@@ -0,0 +1,12 @@
+# ts-overrides-plugin example
+
+Commands:
+
+```bash
+yarn build:tspc
+yarn build:ts-loader
+yarn build:fork-ts
+yarn watch:tspc
+yarn watch:ts-loader
+yarn watch:fork-ts
+```

packages/example/package.json

@@ -1,9 +1,13 @@
 {
   "name": "example",
+  "type": "module",
   "scripts": {
     "build:tspc": "tspc",
     "build:ts-loader": "webpack --config webpack.config.ts-loader.js",
-    "build:fork-ts": "webpack --config webpack.config.fork-ts.js"
+    "build:fork-ts": "webpack --config webpack.config.fork-ts.js",
+    "watch:tspc": "tspc --watch",
+    "watch:ts-loader": "webpack --config webpack.config.ts-loader.js --watch",
+    "watch:fork-ts": "webpack --config webpack.config.fork-ts.js --watch"
   },
   "devDependencies": {
     "@babel/core": "^7.23.6",
@@ -16,8 +20,8 @@
     "ts-loader": "^9.5.1",
     "ts-node": "^10.9.2",
     "ts-overrides-plugin": "workspce:*",
-    "ts-patch": "3.1.1",
-    "typescript": "^5.3.3",
+    "ts-patch": "3.2.0",
+    "typescript": "5.5.1-rc",
     "webpack": "^5.89.0",
     "webpack-cli": "^5.1.4"
   },

packages/example/src/legacy/getDate.ts

@@ -1,6 +1,8 @@
+// ok with strict: false
 export const getDate = (date) => {
-  const modern: string | undefined = 123;
+  const modern: string | undefined = undefined;
 
+  // ok with strict: false
   modern.split('');
 
   return date.toLocaleDateString('ru-RU', {
@@ -10,4 +12,5 @@ export const getDate = (date) => {
   });
 }
 
+// show `string` on hover in IDE
 export const someVar: string | undefined = undefined;

packages/example/src/modern/getDate.ts

@@ -1,11 +1,13 @@
 import { someVar } from '../legacy/getDate';
 
+// Parameter 'date' implicitly has an 'any' type.
 export const getDate = (date) => {
   const modern: string | undefined = undefined;
 
   // Show `string | undefined` on hover in IDE
   console.log(someVar);
 
+  // 'modern' is possibly 'undefined'
   modern.split('');
 
   return date.toLocaleDateString('ru-RU', {

packages/example/webpack.config.fork-ts.js

@@ -1,31 +1,33 @@
-const path = require("path");
+const path = require('path');
 const ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin');
 
 module.exports = [
     {
-        mode: "production",
-        entry: "./src/index.ts",
+        mode: 'production',
+        entry: './src/index.ts',
         output: {
-            path: path.join(__dirname, "build"),
-            filename: "main.js",
+            path: path.join(__dirname, 'build'),
+            filename: 'main.js',
         },
         module: {
             rules: [
                 {
                     test: /\.ts$/,
                     exclude: /node_modules/,
-                    loader: "babel-loader",
+                    loader: 'babel-loader',
                 },
             ],
         },
-        plugins: [new ForkTsCheckerWebpackPlugin({
+        plugins: [
+          new ForkTsCheckerWebpackPlugin({
             typescript: {
                 typescriptPath: require.resolve('ts-patch/compiler'),
             }
-        })],
+          }),
+        ],
         resolve: {
             extensions: ['.ts', '.js'],
         },
-        target: "web",
+        target: 'web',
     }
 ];

packages/example/webpack.config.ts-loader.js

@@ -1,29 +1,28 @@
-const path = require("path");
-const ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin');
+const path = require('path');
 
 module.exports = [
     {
-        mode: "production",
-        entry: "./src/index.ts",
+        mode: 'production',
+        entry: './src/index.ts',
         output: {
-            path: path.join(__dirname, "build"),
-            filename: "main.js",
+            path: path.join(__dirname, 'build'),
+            filename: 'main.js',
         },
         module: {
             rules: [
                 {
                     test: /\.ts$/,
                     exclude: /node_modules/,
-                    loader: "ts-loader",
+                    loader: 'ts-loader',
                     options: {
-                        compiler: 'ts-patch/compiler'
+                        compiler: require.resolve('ts-patch/compiler'),
                     }
                 },
             ],
         },
         resolve: {
             extensions: ['.ts', '.js'],
         },
-        target: "web",
+        target: 'web',
     }
-];
+];