feat: Rename to @eslint/css-tree (#1)

* feat: Rename to @eslint/css-tree

* Update references

* Update package.json

Co-authored-by: Francesco Trotta <github@fasttime.org>

* Revert CHANGELOG changes

* Update module names in script

* Update package-lock.json

---------

Co-authored-by: Francesco Trotta <github@fasttime.org>

Author: nzakas

LICENSE

@@ -1,4 +1,5 @@
 Copyright (C) 2016-2024 by Roman Dvornov
+Copyright OpenJS Foundation and other contributors, <www.openjsf.org>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,12 +1,6 @@
 <img align="right" width="111" height="111" alt="CSSTree logo" src="assets/csstree-logo-rounded.svg" />
 
-# CSSTree
-
-[![NPM version](https://img.shields.io/npm/v/css-tree.svg)](https://www.npmjs.com/package/css-tree)
-[![Build Status](https://github.com/csstree/csstree/actions/workflows/build.yml/badge.svg)](https://github.com/csstree/csstree/actions/workflows/build.yml)
-[![Coverage Status](https://coveralls.io/repos/github/csstree/csstree/badge.svg?branch=master)](https://coveralls.io/github/csstree/csstree?branch=master)
-[![NPM Downloads](https://img.shields.io/npm/dm/css-tree.svg)](https://www.npmjs.com/package/css-tree)
-[![Twitter](https://img.shields.io/badge/Twitter-@csstree-blue.svg)](https://twitter.com/csstree)
+# CSSTree (ESLint Fork)
 
 CSSTree is a tool set for CSS: [fast](https://github.com/postcss/benchmark) detailed parser (CSS → AST), walker (AST traversal), generator (AST → CSS) and lexer (validation and matching) based on specs and browser implementations. The main goal is to be efficient and W3C spec compliant, with focus on CSS analyzing and source-to-source transforming tasks.
 
@@ -90,13 +84,13 @@ CSSTree is a tool set for CSS: [fast](https://github.com/postcss/benchmark) deta
 Install with npm:
 
 ```
-npm install css-tree
+npm install @eslint/css-tree
 ```
 
 Basic usage:
 
 ```js
-import * as csstree from 'css-tree';
+import * as csstree from '@eslint/css-tree';
 
 // parse CSS to AST
 const ast = csstree.parse('.example { world: "!" }');
@@ -136,17 +130,17 @@ console.log(matchResult.getTrace(ast.children.first));
 
 ### Exports
 
-Is it possible to import just a needed part of library like a parser or a walker. That's might useful for loading time or bundle size optimisations. 
+Is it possible to import just a needed part of library like a parser or a walker. That's might useful for loading time or bundle size optimisations.
 
 ```js
-import * as tokenizer from 'css-tree/tokenizer';
-import * as parser from 'css-tree/parser';
-import * as walker from 'css-tree/walker';
-import * as lexer from 'css-tree/lexer';
-import * as definitionSyntax from 'css-tree/definition-syntax';
-import * as data from 'css-tree/definition-syntax-data';
-import * as dataPatch from 'css-tree/definition-syntax-data-patch';
-import * as utils from 'css-tree/utils';
+import * as tokenizer from '@eslint/css-tree/tokenizer';
+import * as parser from '@eslint/css-tree/parser';
+import * as walker from '@eslint/css-tree/walker';
+import * as lexer from '@eslint/css-tree/lexer';
+import * as definitionSyntax from '@eslint/css-tree/definition-syntax';
+import * as data from '@eslint/css-tree/definition-syntax-data';
+import * as dataPatch from '@eslint/css-tree/definition-syntax-data-patch';
+import * as utils from '@eslint/css-tree/utils';
 ```
 
 ### Using in a browser
@@ -155,7 +149,7 @@ Bundles are available for use in a browser:
 
 - `dist/csstree.js` – minified IIFE with `csstree` as global
 ```html
-<script src="node_modules/css-tree/dist/csstree.js"></script>
+<script src="node_modules/@eslint/css-tree/dist/csstree.js"></script>
 <script>
   csstree.parse('.example { color: green }');
 </script>
@@ -164,7 +158,7 @@ Bundles are available for use in a browser:
 - `dist/csstree.esm.js` – minified ES module
 ```html
 <script type="module">
-  import { parse } from 'node_modules/css-tree/dist/csstree.esm.js'
+  import { parse } from 'node_modules/@eslint/css-tree/dist/csstree.esm.js'
   parse('.example { color: green }');
 </script>
 ```
@@ -174,19 +168,27 @@ One of CDN services like `unpkg` or `jsDelivr` can be used. By default (for shor
 ```html
 <!-- ESM -->
 <script type="module">
-  import * as csstree from 'https://cdn.jsdelivr.net/npm/css-tree';
-  import * as csstree from 'https://unpkg.com/css-tree';
+  import * as csstree from 'https://cdn.jsdelivr.net/npm/@eslint/css-tree';
+  import * as csstree from 'https://unpkg.com/@eslint/css-tree';
 </script>
 
 <!-- IIFE with an export to global -->
-<script src="https://cdn.jsdelivr.net/npm/css-tree/dist/csstree.js"></script>
-<script src="https://unpkg.com/css-tree/dist/csstree.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@eslint/css-tree/dist/csstree.js"></script>
+<script src="https://unpkg.com/@eslint/css-tree/dist/csstree.js"></script>
 ```
 
 ## Top level API
 
-![API map](https://cdn.rawgit.com/csstree/csstree/aaf327e/docs/api-map.svg)
+![API map](https://cdn.rawgit.com/eslint/csstree/aaf327e/docs/api-map.svg)
 
 ## License
 
 MIT
+
+
+## Branch Setup and Development
+
+* `main` - the default branch for new development in the fork repo
+* `upstream` - kept in sync with `csstree/csstree`
+
+When merging in changes from `csstree/csstree`, sync `upstream` in the GitHub UI (if possible). Then send a pull request to `main` to work through any merge conflicts.

docs/definition-syntax.md

@@ -28,15 +28,15 @@ This article describes API to work with [Value Definition Syntax](https://www.w3
 
 Arguments:
 
-- **source**: `string`  
+- **source**: `string`
   A definition to parse
 
 ```js
-import { definitionSyntax } from 'css-tree';
+import { definitionSyntax } from '@eslint/css-tree';
 
 definitionSyntax.parse('foo | bar');
 // { Group
-//   terms: 
+//   terms:
 //    [ { Keyword name: 'foo' },
 //      { Keyword name: 'bar' } ],
 //   combinator: '|',
@@ -48,15 +48,15 @@ definitionSyntax.parse('foo | bar');
 
 Arguments:
 
-- **node**: `Object`  
+- **node**: `Object`
   AST node
-- **options**: `{ enter?: function, leave?: function }` or `function`  
+- **options**: `{ enter?: function, leave?: function }` or `function`
   An object to specify enter and/or leave handlers. When value is a function, it treated as `{ enter: function }`. One of handlers is required.
-- **context** (optional): `any`  
+- **context** (optional): `any`
   Defines a value as `this` in enter and leave handlers.
 
 ```js
-import { definitionSyntax } from 'css-tree';
+import { definitionSyntax } from '@eslint/css-tree';
 
 const ast = definitionSyntax.parse('foo | bar');
 
@@ -85,19 +85,19 @@ definitionSyntax.walk(ast, node =>
 
 ## generate(node, options)
 
-- **node**: `Object`  
+- **node**: `Object`
   AST node to generate a string from
-- **options** (optional): `Object`  
+- **options** (optional): `Object`
   An object to specify output behaviour (all options are optional):
-  - **forceBraces**: `Boolean` (default: `false`)  
+  - **forceBraces**: `Boolean` (default: `false`)
     Enforce printing brackets for any groups (even implicit). Useful for debugging and priority revelation.
-  - **compact**: `Boolean` (default: `false`)  
+  - **compact**: `Boolean` (default: `false`)
     Avoid formatting (primary whitespaces around brackets and so on) when possible.
-  - **decorate**: `function(nodeGenerateResult, node)`  
+  - **decorate**: `function(nodeGenerateResult, node)`
     A function to post-process result of node translation to a string. Handy to make some kind of result wrapping.
 
 ```js
-import { definitionSyntax } from 'css-tree';
+import { definitionSyntax } from '@eslint/css-tree';
 
 const ast = definitionSyntax.parse('foo && bar || [ baz | qux ]');
 

docs/generate.md

@@ -26,13 +26,13 @@ Options (optional):
 
 ### sourceMap
 
-Type: `boolean`  
+Type: `boolean`
 Default: `false`
 
 Generates a source map (nodes should contain positions in `loc` property). Note, that an object instead of string is returned in that case.
 
 ```js
-import { parse, generate } from 'css-tree';
+import { parse, generate } from '@eslint/css-tree';
 
 const ast = parse('.test { color: red }', {
     filename: 'my.css',
@@ -45,14 +45,14 @@ const result = generate(ast, { sourceMap: true });
 
 ### decorator
 
-Type: `function`  
+Type: `function`
 Default: none
 
 A function that returns handlers used by a generator. TBD
 
 ### mode
 
-Type: `"spec"` or `"safe"`  
+Type: `"spec"` or `"safe"`
 Default: `"safe"`
 
 CSS Syntax Module defines [rules for CSS serialization](https://www.w3.org/TR/css-syntax-3/#serialization) that it must "round-trip" with parsing. The generator follows these rules and determines itself when to output the space to avoid unintended CSS tokens combining. However, some older browsers fail to parse the resulting CSS because they didn't follow the spec in some cases. For this reason, the generator supports two modes:
@@ -61,7 +61,7 @@ CSS Syntax Module defines [rules for CSS serialization](https://www.w3.org/TR/cs
 - `spec` which completely follows the spec.
 
 ```js
-import { parse, generate } from 'css-tree';
+import { parse, generate } from '@eslint/css-tree';
 
 const ast = parse('a { border: calc(1px) solid #ff0000 }');
 

docs/parsing.md

@@ -7,7 +7,7 @@
 Parses CSS into AST.
 
 ```js
-import { parse } from 'css-tree';
+import { parse } from '@eslint/css-tree';
 
 // simple parsing with no options
 const ast = parse('.example { color: red }');
@@ -42,7 +42,7 @@ Options (optional):
 
 ### context
 
-Type: `string`  
+Type: `string`
 Default: `'stylesheet'`
 
 Defines what part of CSS is parsing.
@@ -64,21 +64,21 @@ Contexts:
 
 ### atrule
 
-Type: `string` or `null`  
+Type: `string` or `null`
 Default: `null`
 
 Using for `atrulePrelude` context to apply atrule specific parse rules.
 
 ### positions
 
-Type: `boolean`  
+Type: `boolean`
 Default: `false`
 
 Specify to store locations of node content in original source. Location is storing as `loc` field of nodes. `loc` property is always `null` when this option is `false`. See structure of [`loc`](ast.md#loc) in AST format description.
 
 ### onParseError
 
-Type: `function(error, fallbackNode)` or `null`  
+Type: `function(error, fallbackNode)` or `null`
 Default: `null`
 
 Parsing is tolerant by default, i.e. any text may to be parsed with no an raised exception. However, mistakes in CSS may make it imposible to parse some part, e.g. a selector or declaration. In that case bad content is wrapping into a `Raw` node and `onParseError` is invoking.
@@ -99,49 +99,49 @@ csstree.parse('example { foo; bar: 1! }', {
 
 ### onComment
 
-Type: `function(value, loc)` or `null`  
+Type: `function(value, loc)` or `null`
 Default: `null`
 
 A handler to call for every comment in parsing source. Value is passing without surrounding `/*` and `*/`. [`loc`](ast.md#loc) will be `null` until `positions` option is set to `true`.
 
 ### onToken
 
-Type: `function(type, start, end, index)` or `Array` or `null`  
+Type: `function(type, start, end, index)` or `Array` or `null`
 Default: `null`
 
 When a function, `onToken` is a handler to call for every token in the parsing source. The arguments are the numeric type of the token, the start offset, the end offset, and the token index. When an array, `onToken` is populated with objects containing the numeric type of the token (`type`), the start offset (`start`), and the end offset (`end`).
 
 ### filename
 
-Type: `string`  
+Type: `string`
 Default: `'<unknown>'`
 
 Filename of source. This value adds to [`loc`](ast.md#loc) as `source` property when `positions` option is `true`. Using for source map generation.
 
 ### offset
 
-Type: `number`  
+Type: `number`
 Default: `0`
 
 Start offset. Useful when parsing a fragment of CSS to store a correct positions for node's [`loc`](ast.md#loc) property.
 
 ### line
 
-Type: `number`  
+Type: `number`
 Default: `1`
 
 Start line number. Useful when parsing fragment of CSS to store correct positions in node's [`loc`](ast.md#loc) property.
 
 ### column
 
-Type: `number`  
+Type: `number`
 Default: `1`
 
 Start column number. Useful when parsing fragment of CSS to store correct positions in node's `loc` property.
 
 ### parseAtrulePrelude
 
-Type: `boolean`  
+Type: `boolean`
 Default: `true`
 
 Defines to parse an at-rule prelude in details (represents as `AtruleExpresion`, `MediaQueryList` or `SelectorList` if any). Otherwise, represents prelude as `Raw` node.
@@ -187,7 +187,7 @@ csstree.parse('@example 1 2;', {
 
 ### parseRulePrelude
 
-Type: `boolean`  
+Type: `boolean`
 Default: `true`
 
 Defines to parse a rule prelude in details or left unparsed (represents as `Raw` node).
@@ -241,7 +241,7 @@ csstree.parse('.foo {}', {
 
 ### parseValue
 
-Type: `boolean`  
+Type: `boolean`
 Default: `true`
 
 Defines to parse a declaration value in details (represents as `Value`). Otherwise represents value as `Raw` node.
@@ -282,7 +282,7 @@ csstree.parse('color: #aabbcc', {
 
 ### parseCustomProperty
 
-Type: `boolean`  
+Type: `boolean`
 Default: `false`
 
 Defines to parse a custom property value and a `var()` fallback in details (represents as `Value`). Otherwise represents value as `Raw` node.