-
Notifications
You must be signed in to change notification settings - Fork 117
feat(yarn-plugin-ignore): Yarn plugin implementing the ignore: protocol
#4065
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| !dist/ | ||
| dist/*.map |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # @rnx-kit/yarn-plugin-ignore | ||
|
|
||
| [](https://github.com/microsoft/rnx-kit/actions/workflows/build.yml) | ||
| [](https://www.npmjs.com/package/@rnx-kit/yarn-plugin-ignore) | ||
|
|
||
| 🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧 | ||
|
|
||
| ### THIS TOOL IS EXPERIMENTAL — USE WITH CAUTION | ||
|
|
||
| 🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧 | ||
|
|
||
| A Yarn plugin for excluding packages from being installed. | ||
|
|
||
| ## Installation | ||
|
|
||
| ```sh | ||
| yarn plugin import https://raw.githubusercontent.com/microsoft/rnx-kit/main/incubator/yarn-plugin-ignore/dist/yarn-plugin-ignore.cjs | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| In the root `package.json`, add a `resolutions` section and use the `ignore:` | ||
| protocol to exclude packages. For example, to exclude `node-gyp`: | ||
|
|
||
| ```diff | ||
| + "resolutions": { | ||
| + "node-gyp": "ignore:" | ||
| + }, | ||
| ``` | ||
153 changes: 153 additions & 0 deletions
153
incubator/yarn-plugin-ignore/dist/yarn-plugin-ignore.cjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| /* eslint-disable */ | ||
| //prettier-ignore | ||
| module.exports = { | ||
| name: "@rnx-kit/yarn-plugin-ignore", | ||
| factory: function (require) { | ||
| "use strict"; | ||
| var plugin = (() => { | ||
| var __create = Object.create; | ||
| var __defProp = Object.defineProperty; | ||
| var __getOwnPropDesc = Object.getOwnPropertyDescriptor; | ||
| var __getOwnPropNames = Object.getOwnPropertyNames; | ||
| var __getProtoOf = Object.getPrototypeOf; | ||
| var __hasOwnProp = Object.prototype.hasOwnProperty; | ||
| var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, { | ||
| get: (a, b) => (typeof require !== "undefined" ? require : a)[b] | ||
| }) : x)(function(x) { | ||
| if (typeof require !== "undefined") return require.apply(this, arguments); | ||
| throw Error('Dynamic require of "' + x + '" is not supported'); | ||
| }); | ||
| var __export = (target, all) => { | ||
| for (var name in all) | ||
| __defProp(target, name, { get: all[name], enumerable: true }); | ||
| }; | ||
| var __copyProps = (to, from, except, desc) => { | ||
| if (from && typeof from === "object" || typeof from === "function") { | ||
| for (let key of __getOwnPropNames(from)) | ||
| if (!__hasOwnProp.call(to, key) && key !== except) | ||
| __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable }); | ||
| } | ||
| return to; | ||
| }; | ||
| var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps( | ||
| // If the importer is in node compatibility mode or this is not an ESM | ||
| // file that has been converted to a CommonJS file using a Babel- | ||
| // compatible transform (i.e. "__esModule" has not been set), then set | ||
| // "default" to the CommonJS "module.exports" for node compatibility. | ||
| isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, | ||
| mod | ||
| )); | ||
| var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod); | ||
|
|
||
| // src/index.ts | ||
| var index_exports = {}; | ||
| __export(index_exports, { | ||
| IgnoreFetcher: () => IgnoreFetcher, | ||
| IgnoreResolver: () => IgnoreResolver, | ||
| default: () => index_default | ||
| }); | ||
|
|
||
| // src/IgnoreFetcher.ts | ||
| var import_fslib = __require("@yarnpkg/fslib"); | ||
| var fs = __toESM(__require("fs"), 1); | ||
|
|
||
| // src/constants.ts | ||
| var IGNORE_PROTOCOL = "ignore:"; | ||
| var STUB_MODULE = `module.exports = {}; | ||
| `; | ||
| var STUB_PACKAGE = `{ | ||
| "name": "@rnx-kit/yarn-plugin-ignore/stub", | ||
| "version": "0.0.0", | ||
| "description": "Stub package for '@rnx-kit/yarn-plugin-ignore'", | ||
| "main": "index.js" | ||
| } | ||
| `; | ||
|
|
||
| // src/IgnoreFetcher.ts | ||
| var IgnoreFetcher = class { | ||
| supports(locator) { | ||
| return locator.reference.startsWith(IGNORE_PROTOCOL); | ||
| } | ||
| getLocalPath() { | ||
| return null; | ||
| } | ||
| async fetch(_locator, opts) { | ||
| const base = opts.project.cwd; | ||
| const sourceFs = new import_fslib.CwdFS(base); | ||
| const localPath = import_fslib.ppath.resolve( | ||
| base, | ||
| "node_modules", | ||
| ".generated", | ||
| "@rnx-kit", | ||
| "yarn-plugin-ignore-stub" | ||
| ); | ||
| const nativePath = import_fslib.npath.fromPortablePath(localPath); | ||
| if (!fs.existsSync(nativePath)) { | ||
| fs.mkdirSync(nativePath, { recursive: true, mode: 493 }); | ||
| fs.writeFileSync(import_fslib.npath.join(nativePath, "package.json"), STUB_PACKAGE); | ||
| fs.writeFileSync(import_fslib.npath.join(nativePath, "index.js"), STUB_MODULE); | ||
| } | ||
| return { | ||
| packageFs: new import_fslib.CwdFS(localPath, { baseFs: sourceFs }), | ||
| prefixPath: import_fslib.PortablePath.dot, | ||
| discardFromLookup: true, | ||
| localPath | ||
| }; | ||
| } | ||
| }; | ||
|
|
||
| // src/IgnoreResolver.ts | ||
| var import_core = __require("@yarnpkg/core"); | ||
| var import_node_assert = __require("assert"); | ||
| var IgnoreResolver = class { | ||
| supportsDescriptor(descriptor) { | ||
| return descriptor.range.startsWith(IGNORE_PROTOCOL); | ||
| } | ||
| supportsLocator(locator) { | ||
| return locator.reference.startsWith(IGNORE_PROTOCOL); | ||
| } | ||
| shouldPersistResolution() { | ||
| return false; | ||
| } | ||
| bindDescriptor(descriptor, _fromLocator) { | ||
| return descriptor; | ||
| } | ||
| getResolutionDependencies() { | ||
| return {}; | ||
| } | ||
| async getCandidates(descriptor, _dependencies, _opts) { | ||
| return [import_core.structUtils.makeLocator(descriptor, IGNORE_PROTOCOL)]; | ||
| } | ||
| async getSatisfying(_descriptor, _dependencies, locators, _opts) { | ||
| (0, import_node_assert.equal)(locators.length, 1, "Expected a single locator candidate"); | ||
| return { locators, sorted: true }; | ||
| } | ||
| async resolve(locator, opts) { | ||
| const manifest = new import_core.Manifest(); | ||
| return { | ||
| ...locator, | ||
| version: "0.0.0", | ||
| languageName: opts.project.configuration.get("defaultLanguageName"), | ||
| linkType: import_core.LinkType.SOFT, | ||
| conditions: null, | ||
| dependencies: manifest.dependencies, | ||
| peerDependencies: manifest.peerDependencies, | ||
| dependenciesMeta: manifest.dependenciesMeta, | ||
| peerDependenciesMeta: manifest.peerDependenciesMeta, | ||
| bin: manifest.bin | ||
| }; | ||
| } | ||
| }; | ||
|
|
||
| // src/index.ts | ||
| var plugin = { | ||
| fetchers: [IgnoreFetcher], | ||
| resolvers: [IgnoreResolver] | ||
| }; | ||
| var index_default = plugin; | ||
| return __toCommonJS(index_exports); | ||
| })(); | ||
| return plugin; | ||
| } | ||
| }; | ||
| //# sourceMappingURL=yarn-plugin-ignore.cjs.map |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| { | ||
| "name": "@rnx-kit/yarn-plugin-ignore", | ||
| "version": "0.0.1", | ||
| "private": true, | ||
| "description": "EXPERIMENTAL - USE WITH CAUTION - yarn-plugin-ignore", | ||
| "homepage": "https://github.com/microsoft/rnx-kit/tree/main/incubator/yarn-plugin-ignore#readme", | ||
| "license": "MIT", | ||
| "author": { | ||
| "name": "Microsoft Open Source", | ||
| "email": "microsoftopensource@users.noreply.github.com" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/microsoft/rnx-kit", | ||
| "directory": "incubator/yarn-plugin-ignore" | ||
| }, | ||
| "files": [ | ||
| "dist/yarn-plugin-ignore.cjs" | ||
| ], | ||
| "type": "module", | ||
| "main": "dist/yarn-plugin-ignore.cjs", | ||
| "scripts": { | ||
| "build": "rnx-kit-scripts build", | ||
| "bundle": "rnx-kit-scripts bundle --platform yarn --sourceMap", | ||
| "format": "rnx-kit-scripts format", | ||
| "lint": "rnx-kit-scripts lint", | ||
| "test": "rnx-kit-scripts test" | ||
| }, | ||
| "devDependencies": { | ||
| "@rnx-kit/scripts": "*", | ||
| "@rnx-kit/tsconfig": "*", | ||
| "@yarnpkg/core": "^4.2.0", | ||
| "@yarnpkg/fslib": "^3.1.1" | ||
| }, | ||
| "engines": { | ||
| "node": ">=18.12", | ||
| "yarn": ">=4.0" | ||
| }, | ||
| "experimental": true | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| import type { | ||
| Fetcher, | ||
| FetchOptions, | ||
| FetchResult, | ||
| Locator, | ||
| } from "@yarnpkg/core"; | ||
| import { CwdFS, npath, PortablePath, ppath } from "@yarnpkg/fslib"; | ||
| import * as fs from "node:fs"; | ||
| import { IGNORE_PROTOCOL, STUB_MODULE, STUB_PACKAGE } from "./constants.ts"; | ||
|
|
||
| export class IgnoreFetcher implements Fetcher { | ||
| supports(locator: Locator): boolean { | ||
| return locator.reference.startsWith(IGNORE_PROTOCOL); | ||
| } | ||
|
|
||
| getLocalPath(): PortablePath | null { | ||
| return null; | ||
| } | ||
|
|
||
| async fetch(_locator: Locator, opts: FetchOptions): Promise<FetchResult> { | ||
| const base = opts.project.cwd; | ||
| const sourceFs = new CwdFS(base); | ||
| const localPath = ppath.resolve( | ||
| base, | ||
| "node_modules", | ||
| ".generated", | ||
| "@rnx-kit", | ||
| "yarn-plugin-ignore-stub" | ||
| ); | ||
|
|
||
| const nativePath = npath.fromPortablePath(localPath); | ||
| if (!fs.existsSync(nativePath)) { | ||
| fs.mkdirSync(nativePath, { recursive: true, mode: 0o755 }); | ||
| fs.writeFileSync(npath.join(nativePath, "package.json"), STUB_PACKAGE); | ||
| fs.writeFileSync(npath.join(nativePath, "index.js"), STUB_MODULE); | ||
| } | ||
|
|
||
| return { | ||
| packageFs: new CwdFS(localPath, { baseFs: sourceFs }), | ||
| prefixPath: PortablePath.dot, | ||
| discardFromLookup: true, | ||
| localPath, | ||
| }; | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.