Skip to content

Commit

Permalink
Remove deprecated project.writeSync
Browse files Browse the repository at this point in the history
  • Loading branch information
lolmaus committed Aug 3, 2023
1 parent 4e290a4 commit fd17ebe
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 24 deletions.
13 changes: 2 additions & 11 deletions README.md
Expand Up @@ -27,12 +27,12 @@ project.addDependency('chai', '5.2.0');
project.pkg; // => the contents of package.json for the given project
project.files; // => read or write the set of files further

// if you don't set this, a new temp dir will be made for you when you writeSync()
// if you don't set this, a new temp dir will be made for you when you write()
project.baseDir = 'some/base/dir/';

await project.write();

// after writeSync(), you can read project.baseDir even if you didn't set it
// after write(), you can read project.baseDir even if you didn't set it
expect(fs.existsSync(join(project.baseDir, 'index.js'))).to.eql(true);
```

Expand Down Expand Up @@ -144,7 +144,6 @@ appropriate for apps) you can use `linkDevDeps` instead.
- [project.version](#projectversion)
- [project.mergeFiles(dirJSON)](#projectmergefilesdirjson)
- [project.write(dirJSON?)](#projectwritedirjson)
- [~~project.writeSync()~~](#projectwritesync)
- [project.addDependency() ⇒](#projectadddependency-)
- [project.addDevDependency() ⇒](#projectadddevdependency-)
- [project.removeDependency(name)](#projectremovedependencyname)
Expand Down Expand Up @@ -219,14 +218,6 @@ appropriate for apps) you can use `linkDevDeps` instead.
| --- | --- |
| dirJSON? | <p>An optional object containing a directory representation to write.</p> |

<a name="Project+writeSync"></a>

### ~~project.writeSync()~~
***Deprecated***

**Kind**: instance method of [<code>Project</code>](#Project)
<a name="Project+addDependency"></a>

### project.addDependency() ⇒
<p>Adds a dependency to the Project's package.json.</p>

Expand Down
13 changes: 0 additions & 13 deletions src/index.ts
Expand Up @@ -7,7 +7,6 @@ import CacheGroup from 'resolve-package-path/lib/cache-group.js';
import binLinks from 'bin-links';
import { PackageJson as BasePackageJson } from 'type-fest';
import walkSync from 'walk-sync';
import { deprecate } from 'util';
import deepmerge from 'deepmerge';
const { entries } = walkSync;

Expand Down Expand Up @@ -238,13 +237,6 @@ export class Project {
await this.binLinks();
}

/**
* @deprecated Please use `await project.write()` instead.
*/
writeSync() {
this.writeProject();
}

addDependency(
name?: string,
version?: string,
Expand Down Expand Up @@ -804,11 +796,6 @@ function readPackages(modulesPath: string): { pkg: PackageJson; path: string }[]
return pkgs;
}

Project.prototype.writeSync = deprecate(
Project.prototype.writeSync,
'project.writeSync() is deprecated. Use await project.write() instead'
);

export type LinkParams =
| { baseDir: string; resolveName?: string; requestedRange?: string }
| { target: string; requestedRange?: string }
Expand Down

0 comments on commit fd17ebe

Please sign in to comment.