add installations clean/show

Author: wclr

.npmignore

@@ -3,4 +3,5 @@
 tsconfig.json
 /test
 *.lock
-.*
+.*
+*.yml

.vscode/settings.json

@@ -3,19 +3,17 @@
   "search.exclude": {},
   "files.exclude": {
     "**/*.js": {
-			"when": "$(basename).ts"
-		},
-		"**/*.js.map": {
-			"when": "$(basename).ts"
-		},
-		"**/*.d.ts": {
-			"when": "$(basename).ts"
-		}			
+      "when": "$(basename).ts"
+    },
+    "**/*.js.map": true,
+    "**/*.d.ts": {
+      "when": "$(basename).ts"
+    }
   },
-  "prettier.tslintIntegration": true,
+  "prettier.tslintIntegration": false,
   // "tslint.run": "onSave",
   // "tslint.autoFixOnSave": true,
   //"editor.formatOnType": true,
   "editor.tabSize": 2,
-  "editor.insertSpaces": true  
-}
+  "editor.insertSpaces": true
+}

.yalcignore

@@ -0,0 +1 @@
+*.md

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Yalc changelog
 
+## 1.0.0.pre.24
+- postupdate script on update (and push)
+- new file inclusion algorithm with `npm-packlist`
+- .yalcignore added
+- installations show/clean commmand
+
 ## 1.0.0.pre.16 (2018-01-02)
 - fix package deps
 - fix `--link` removal

README.md

@@ -35,12 +35,17 @@ yarn global add yalc
 
 ### Publish
 - Run `yalc publish` in your dependency package `my-package`. 
-- It will copy [all the files that should be published in remote NPM registry](https://docs.npmjs.com/files/package.json#files), but will not include standard non-code files like `README`, `LICENCE` etc. (If you need them included, add `!LICENCE` to `.npmignore`).
+- It will copy [all the files that should be published in remote NPM registry](https://docs.npmjs.com/files/package.json#files).
+
 - It will run `preyalc` or `prepublish` scripts before, and `postyalc` or `postpublish` after. Use `--force` to publish without running scripts.
 
+- While copying package content, `yalc` calculates the hash signature of all files and, by default, adds this signature to the package manifest `version`. You can disable this by using the `--no-sig` option.
+
+- You may also use `.yalcignore` to exclude files from publishing to yalc repo, for example files like README.md, etc.
+
 - **NB!** Windows users should make sure the `LF` new line symbol is used in published sources; it may be needed for some packages to work correctly (for example, `bin` scripts). `yalc` won't convert line endings for you (because `npm` and `yarn` won't either).
 
-- While copying package content, `yalc` calculates the hash signature of all files and, by default, adds this signature to the package manifest `version`. You can disable this by using the `--no-sig` option.
+- **NB!** Note that, if you want to include `.yalc` folder in published package content, you should add `!.yalc` line to `.npmignore`.
 
 - [Easily propagate package updates everywhere.](#pushing-updates-automatically-to-all-installations)
 
@@ -87,11 +92,17 @@ will copy the current version from the store to your project's `.yalc` folder an
 ### Keep it in git
 - You may want to keep shared `yalc'ed` stuff within the projects you are working on and treat it as a part of the project's codebase. This may really simplify management and usage of shared *work in progress* packages within your projects and help to make things consistent. So, then just do it, keep `.yalc` folder and `yalc.lock` in git. 
 - Replace it with published versions from remote repository when ready.
+- **NB!** - standard non-code files like `README`, `LICENCE` etc. will be included also, so you may want to excluded them in `.gitignore` with a line like `**/.yalc/**/*.md` or you may use `.yalcignore` not to include those files in package content.
+
 
 ### Publish/push sub-projects
 
 - Useful for monorepos (projects with multiple sub-projects/packages): `yalc publish package-dir will perform publish operation in nested `package` folder of current working dir.
 
+### Clean up installations file
+
+- While working with yalc for some time on the dev machine you may face the situation when you have locations where you added yalc'ed packages being removed from file system, and this will cause some warning messages when yalc will try to push package to removed location. To get rid of such messages there in an explicit command for this `yalc installations clean [package]`.
+
 
 ## Related links
 

package.json

@@ -1,29 +1,34 @@
 {
   "name": "yalc",
-  "version": "1.0.0-pre.23",
+  "version": "1.0.0-pre.24",
   "description": "Work yarn packages locally like a boss.",
   "homepage": "https://github.com/whitecolor/yalc",
   "repository": {
     "type": "git",
     "url": "https://github.com/whitecolor/yalc.git"
   },
+  "prettier": {
+    "semi": false,
+    "singleQuote": true
+  },
   "bin": {
     "yalc": "src/yalc.js"
   },
   "main": "src/index.js",
   "scripts": {
     "build": "tsc",
+    "clean": "trash **/*.js **/*.js.map **/*.d.ts **/*.log !**/node_modules/**",
     "precommit": "yalc check",
-    "prepublishOnly": "tsc && yarn test",
+    "prepublishOnly": "yarn clean && tsc && yarn test",
     "test": "tsc && mocha test && yarn lint",
     "watch": "mocha test --watch",
     "ci": "tsc && yarn test",
     "lint": "tslint -p ."
   },
-  "license": "MIT",
   "dependencies": {
     "del": "^2.2.2",
     "fs-extra": "^4.0.2",
+    "ignore": "^5.0.4",
     "npm-packlist": "^1.1.12",
     "user-home": "^2.0.0",
     "yargs": "^7.1.0"
@@ -45,6 +50,7 @@
     "tslint": "^5.11.0",
     "tslint-config-prettier": "^1.15.0",
     "tslint-plugin-prettier": "^1.3.0",
-    "typescript": "2.6.1-insiders.20171016"
-  }
+    "typescript": "^3.2.0-rc"
+  },
+  "license": "MIT"
 }

src/add.ts

@@ -23,6 +23,8 @@ export interface AddPackagesOptions {
   linkDep?: boolean
   yarn?: boolean
   safe?: boolean
+  to?: string
+  from?: string
   workingDir: string
 }
 

src/copy.ts

@@ -1,8 +1,10 @@
 import * as fs from 'fs-extra'
 import * as crypto from 'crypto'
 import * as npmPacklist from 'npm-packlist'
+import ignore from 'ignore'
 
 import { join, dirname } from 'path'
+import { readIgnoreFile } from '.'
 import {
   PackageManifest,
   getStorePackagesDir,
@@ -47,9 +49,14 @@ export const copyPackageToStore = async (
   const copyFromDir = options.workingDir
   const locPackageStoreDir = join(getStorePackagesDir(), pkg.name, pkg.version)
 
-  fs.removeSync(locPackageStoreDir)
+  await fs.remove(locPackageStoreDir)
+
+  const ignoreFileContent = readIgnoreFile(workingDir)
+  
+  const ignoreRule = ignore().add(ignoreFileContent)
+  const filesToCopy = (await npmPacklist({ path: workingDir }))
+    .filter(f => !ignoreRule.ignores(f))
 
-  const filesToCopy = await npmPacklist({ path: workingDir })
   const hashes = await Promise.all(
     filesToCopy
       .sort()

src/index.ts

@@ -8,6 +8,7 @@ const { join } = path
 
 export const values = {
   myNameIs: 'yalc',
+  ignoreFileName: '.yalcignore',
   myNameIsCapitalized: 'Yalc',
   lockfileName: 'yalc.lock',
   yalcPackagesFolder: '.yalc',
@@ -65,6 +66,8 @@ export interface PackageManifest {
   devDependencies?: { [name: string]: string }
   scripts?: {
     preinstall?: string
+    postupdate: string
+    postpush: string
     install?: string
     prepublish?: string
     prepublishOnly?: string
@@ -134,6 +137,16 @@ export function readSignatureFile(workingDir: string) {
   }
 }
 
+export function readIgnoreFile(workingDir: string) {
+  const flePath = join(workingDir, values.ignoreFileName)
+  try {
+    const fileData = fs.readFileSync(flePath, 'utf-8')
+    return fileData
+  } catch (e) {
+    return ''
+  }
+}
+
 export function writeSignatureFile(workingDir: string, signature: string) {
   const signatureFilePath = join(workingDir, signatureFileName)
   try {

src/installations.ts

@@ -1,6 +1,7 @@
 import * as fs from 'fs-extra'
 import * as path from 'path'
-import { getStoreMainDir, values } from '.'
+import { getStoreMainDir, values, readPackageManifest } from '.'
+import { readLockfile } from './lockfile'
 
 export type PackageName = string & { __packageName: true }
 
@@ -34,6 +35,68 @@ export const readInstallationsFile = (): InstallationsFile => {
   return installationsConfig
 }
 
+export const showInstallations = ({ packages }: { packages: string[] }) => {
+  const config = readInstallationsFile()
+  Object.keys(config)
+    .filter(
+      packageName =>
+        packages.length ? packages.indexOf(packageName) >= 0 : true
+    )
+    .map((name: PackageName) => ({ name, locations: config[name] }))
+    .forEach(({ name, locations }) => {
+      console.log(`Installations of package ${name}:`)
+      locations.forEach(loc => {
+        console.log(`  ${loc}`)
+      })
+    })
+}
+
+export const cleanInstallations = async ({
+  packages,
+  dry
+}: {
+  packages: string[],
+  dry: boolean
+}) => {
+  const config = readInstallationsFile()
+  const installsToRemove = Object.keys(config)
+    .filter(
+      packageName =>
+        packages.length ? packages.indexOf(packageName) >= 0 : true
+    )
+    .map((name: PackageName) => ({ name, locations: config[name] }))
+    .reduce(
+      (list, { name, locations }) => {
+        return locations.reduce((list, loc) => {
+          const lockfile = readLockfile({ workingDir: loc })
+          const lockPackages = Object.keys(lockfile.packages)
+          if (lockPackages.indexOf(name) < 0) {
+            return list.concat([
+              {
+                name,
+                version: '',
+                path: loc
+              }
+            ])
+          }
+          return list
+        }, list)
+      },
+      [] as PackageInstallation[]
+    )
+  if (installsToRemove.length) {
+    console.log(`Installations clean up:`)
+    installsToRemove.forEach(inst => {
+      console.log(`Package ${inst.name}: ${inst.path}`)
+    })
+    if (!dry) {
+      await removeInstallations(installsToRemove)
+    } else {
+      console.log(`Dry run.`)
+    }
+  }
+}
+
 export const saveInstallationsFile = async (
   installationsConfig: InstallationsFile
 ) => {
@@ -66,7 +129,7 @@ export const addInstallations = async (
 }
 
 export const removeInstallations = async (
-  installations: (PackageInstallation)[]
+  installations: PackageInstallation[]
 ) => {
   const installationsConfig = readInstallationsFile()
   let updated = false