Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Updating deprecations.js file to be more straightforward #1581

Merged
merged 8 commits into from
Sep 10, 2021
Merged

Updating deprecations.js file to be more straightforward #1581

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8c0d626
Updating deprecations.js file to be more straightforward
jonrohan Sep 10, 2021
e8e1e8b
Create poor-coins-fix.md
jonrohan Sep 10, 2021
0cf31ee
Remove tests
jonrohan Sep 10, 2021
aff1bf4
Adding more info about the deprecation to the doc
jonrohan Sep 10, 2021
039fa2b
Title section
jonrohan Sep 10, 2021
efb967d
Moving data to deprecations.json
jonrohan Sep 10, 2021
d1d6938
Moving data to deprecations.json
jonrohan Sep 10, 2021
de3f8b2
Lint only scss files
jonrohan Sep 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/poor-coins-fix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@primer/css": minor
---

Updating deprecations.js file to be more straightforward
58 changes: 0 additions & 58 deletions __tests__/css.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import {
getCurrentVersion,
getDeprecatedSelectors,
getDeprecatedVariables,
getPackageStats,
getSelectorDiff,
getVariableDiff
Expand All @@ -10,17 +8,6 @@ import semver from 'semver'

let selectorsDiff, variablesDiff, version

// Because of a change in analyzer this was incorrectly in the list
const variableAllowList = ['$marketing-all-spacers']
const selectorAllowList = [
'.Truncate .Truncate-text',
'.Truncate .Truncate-text+.Truncate-text',
'.Truncate .Truncate-text.Truncate-text--expandable:active',
'.Truncate .Truncate-text.Truncate-text--expandable:focus',
'.Truncate .Truncate-text.Truncate-text--expandable:hover',
'.Truncate .Truncate-text.Truncate-text--primary'
]

beforeAll(async () => {
selectorsDiff = getSelectorDiff()
variablesDiff = getVariableDiff()
Expand All @@ -33,48 +20,3 @@ describe('css', () => {
expect(supportStats.size).toEqual(0)
})
})

describe('deprecations', () => {
it('A selector was marked as deprecated but not removed from the codebase', () => {
const removed = selectorsDiff['removed']
const deprecations = getDeprecatedSelectors(version.raw)
if (deprecations.length) {
// Selectors were marked to be deprecated in this version,
// but were not removed from the codebase. Please remove these selectors.
expect(deprecations.sort()).toEqual(removed.sort()) // eslint-disable-line jest/no-conditional-expect
}
})

it('A selector was removed from the codebase but not added to upcoming major release deprecations file.', () => {
const removedSelectors = selectorsDiff['removed'].filter(v => !selectorAllowList.includes(v))

if (version.minor !== 0 && version.patch !== 0) {
const nextMajor = semver.inc(version.raw, 'major')
const deprecations = getDeprecatedSelectors(nextMajor)
// Some classes were removed from the codebase, but not found
// in the next upcoming major release deprecation.js
expect(deprecations.sort()).toEqual(expect.arrayContaining(removedSelectors.sort())) // eslint-disable-line jest/no-conditional-expect
}
})

it('A variable was marked as deprecated but not removed from the codebase', () => {
const removed = variablesDiff.removed
const deprecations = getDeprecatedVariables(version.raw)
if (deprecations.length) {
// Variables were marked to be deprecated in this version,
// but were not removed from the codebase. Please remove these variables.
expect(deprecations.sort()).toEqual(removed.sort()) // eslint-disable-line jest/no-conditional-expect
}
})

it('A variable was removed from the codebase and added to upcoming major release deprecations file.', () => {
const removed = variablesDiff.removed.filter(v => !variableAllowList.includes(v))
if (version.minor !== 0 && version.patch !== 0) {
const nextMajor = semver.inc(version.raw, 'major')
const deprecations = getDeprecatedVariables(nextMajor)
// Some variables were removed from the codebase, but not found
// in the next upcoming major release deprecation.json
expect(deprecations).toEqual(expect.arrayContaining(removed)) // eslint-disable-line jest/no-conditional-expect
}
})
})
14 changes: 0 additions & 14 deletions __tests__/utils/css.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,6 @@ export function getCurrentVersion() {
return semver.parse(pkg.version)
}

export function getDeprecatedSelectors(version) {
if (getCurrentVersion().raw === version) return []
let deprecations = JSON.parse(fs.readFileSync(join(currentPath, './dist/deprecations.json')))
deprecations = deprecations.versions[version] || []
return deprecations.reduce((list, deprecation) => list.concat(deprecation.selectors), []).filter(v => v)
}

export function getDeprecatedVariables(version) {
if (getCurrentVersion().raw === version) return []
let deprecations = JSON.parse(fs.readFileSync(join(currentPath, './dist/deprecations.json')))
deprecations = deprecations.versions[version] || []
return deprecations.reduce((list, deprecation) => list.concat(deprecation.variables), []).filter(v => v)
}

export function getPackageStats(packageName) {
const stats = JSON.parse(fs.readFileSync(join(currentPath, './dist', `./stats/${packageName}.json`)))
return stats
Expand Down
Loading