https://github.com/ollm/short-windows-path
Converts a Windows path to 8.3 short path
https://github.com/ollm/short-windows-path
Last synced: 6 months ago
JSON representation
Converts a Windows path to 8.3 short path
- Host: GitHub
- URL: https://github.com/ollm/short-windows-path
- Owner: ollm
- License: mit
- Created: 2024-06-30T08:28:30.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-08-17T10:11:46.000Z (11 months ago)
- Last Synced: 2025-10-23T02:51:33.426Z (9 months ago)
- Language: JavaScript
- Size: 22.5 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# short-windows-path
On Windows, this package tries to generate a short path using javascript, like `C:\Program Files (x86)\Windows Media Player\Media Renderer\DMR_120.png` to `C:\PROGRA~2\WINDOW~4\MEDIAR~1\DMR_120.png`. On other OS it returns the same path.
This can be used to bypass the 260 character limit on Windows by reducing the path length.
**Table of Contents**
- [Installation](#installation)
- [Methods](#methods)
- [Simple example of package usage](#simple-example-of-package-usage)
- [setCacheTime](#setcachetime)
- [generate](#generate)
- [generateSync](#sync)
- [get](#get)
## Installation
```js
npm install short-windows-path
```
## Methods
This package can be used using CommonJS or ES Module.
```js
// CommonJS
const shortWindowsPath = require('short-windows-path');
// ES Module
import * as shortWindowsPath from 'short-windows-path';
```
### Simple example of package usage
```js
const fs = require('fs');
const p = require('path');
const shortWindowsPath = require('short-windows-path');
shortWindowsPath.setCacheTime(5000); // In milliseconds
// Using shortWindowsPath.generate
(async function(){
const files = await fs.promises.readdir('C:\\Program Files (x86)');
let shortened = {};
console.time('shortWindowsPath.generate');
for(let key in files)
{
const file = files[key];
const path = p.join('C:\\Program Files (x86)', file);
let shortPath = await shortWindowsPath.generate(path, true);
shortened[path] = shortPath;
}
console.timeEnd('shortWindowsPath.generate');
console.log(shortened);
})();
// Using shortWindowsPath.generateSync
(function(){
const files = fs.readdirSync('C:\\Program Files (x86)');
let shortened = {};
console.time('shortWindowsPath.generateSync');
for(let key in files)
{
const file = files[key];
const path = p.join('C:\\Program Files (x86)', file);
let shortPath = shortWindowsPath.generateSync(path, true);
shortened[path] = shortPath;
}
console.timeEnd('shortWindowsPath.generateSync');
console.log(shortened);
})();
// Using shortWindowsPath.get
(async function(){
const files = await fs.promises.readdir('C:\\Program Files (x86)');
let shortened = {};
console.time('shortWindowsPath.get');
for(let key in files)
{
const file = files[key];
const path = p.join('C:\\Program Files (x86)', file);
let shortPath = await shortWindowsPath.get(path, true);
shortened[path] = shortPath;
}
console.timeEnd('shortWindowsPath.get');
console.log(shortened);
})();
```
### setCacheTime
Set the cache time, some data is cached to optimize the generation of the short path and reduce disk reads, the cache may result in not generating the full short path of newly created folder/files if a short path has been generated in the same place recently.
```js
const shortPath = shortWindowsPath.setCacheTime(Int time = 10000);
```
- __time__ Cache time in milliseconds.
### generate
Try to generate the short path and check that it exists, this method is faster than `shortWindowsPath.get` but may not get the short path for some folder/files, also uses various read functions to generate the path (`fs.promises.readdir`, `fs.promises.stat` and `fs.existsSync`)
```js
const shortPath = await shortWindowsPath.generate(String path, Boolean force = false);
```
- __force__ Force the sort path generation, by default the short path it is only generated if the path is equal or greater than 260 characters and it will stop generating when the path is below.
### generateSync
Try to generate the short path and check that it exists synchronously, this method is faster than `shortWindowsPath.get` but may not get the short path for some folder/files, also uses various read functions to generate the path (`fs.readdirSync`, `fs.statSync` and `fs.existsSync`)
```js
const shortPath = shortWindowsPath.generateSync(String path, Boolean force = false);
```
- __force__ Force the sort path generation, by default the short path it is only generated if the path is equal or greater than 260 characters and it will stop generating when the path is below.
### get
Get the shorten path using the command `for %I in ("path") do @echo %~sI`, this can be slower that other methods but it will return the correct short path.
```js
const shortPath = await shortWindowsPath.get(String path, Boolean force = false);
```
- __force__ Force the sort path generation, by default the short path it is only generated if the path is equal or greater than 260 characters.