Skip to content

[xdg_directories] Add stateHome property #7766

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

Merged
merged 3 commits into from
Oct 4, 2024
Merged

[xdg_directories] Add stateHome property #7766

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5f25ba4
Add `stateHome` property to `xdg_directories`
Craftplacer Oct 2, 2024
c5cb34a
Bump package version to 1.0.5 and include CHANGELOG
Craftplacer Oct 2, 2024
5007a39
Change version to 1.1.0
Craftplacer Oct 3, 2024
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
3 changes: 2 additions & 1 deletion packages/xdg_directories/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## NEXT
## 1.1.0

* Updates minimum supported SDK version to Flutter 3.19/Dart 3.3.
* Adds `stateHome` property for `XDG_STATE_HOME`.

## 1.0.4

Expand Down
1 change: 1 addition & 0 deletions packages/xdg_directories/example/lib/main.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ class _MyHomePageState extends State<MyHomePage> {
'Config Directories: \n${configDirs.map((Directory directory) => directory.path).toList().join('\n')}\n'),
Text('Cache Home: \n${cacheHome.path}\n'),
Text('Runtime Directory: \n${runtimeDir?.path}\n'),
Text('State Home: \n${stateHome.path}\n'),
const SizedBox(
height: 100,
),
Expand Down
7 changes: 7 additions & 0 deletions packages/xdg_directories/lib/xdg_directories.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,13 @@ Directory get dataHome =>
/// Throws [StateError] if the HOME environment variable is not set.
Directory? get runtimeDir => _directoryFromEnvironment('XDG_RUNTIME_DIR');

/// The base directory relative to which user-specific state data should be
/// written. (Corresponds to `$XDG_STATE_HOME`).
///
/// Throws [StateError] if the HOME environment variable is not set.
Directory get stateHome =>
_directoryFromEnvironmentWithFallback('XDG_STATE_HOME', '.local/state');

/// Gets the xdg user directory named by `dirName`.
///
/// Use [getUserDirectoryNames] to find out the list of available names.
Expand Down
2 changes: 1 addition & 1 deletion packages/xdg_directories/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: xdg_directories
description: A Dart package for reading XDG directory configuration information on Linux.
repository: https://github.com/flutter/packages/tree/main/packages/xdg_directories
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+xdg_directories%22
version: 1.0.4
version: 1.1.0

environment:
sdk: ^3.3.0
Expand Down
4 changes: 4 additions & 0 deletions packages/xdg_directories/test/xdg_directories_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,12 @@ void main() {
'${testPath('usr/local/test_share')}:${testPath('usr/test_share')}';
fakeEnv['XDG_DATA_HOME'] = testPath('.local/test_share');
fakeEnv['XDG_RUNTIME_DIR'] = testPath('.local/test_runtime');
fakeEnv['XDG_STATE_HOME'] = testPath('.local/test_state');
Directory(fakeEnv['XDG_CONFIG_HOME']!).createSync(recursive: true);
Directory(fakeEnv['XDG_CACHE_HOME']!).createSync(recursive: true);
Directory(fakeEnv['XDG_DATA_HOME']!).createSync(recursive: true);
Directory(fakeEnv['XDG_RUNTIME_DIR']!).createSync(recursive: true);
Directory(fakeEnv['XDG_STATE_HOME']!).createSync(recursive: true);
File(path.join(fakeEnv['XDG_CONFIG_HOME']!, 'user-dirs.dirs'))
.writeAsStringSync(r'''
XDG_DESKTOP_DIR="$HOME/Desktop"
Expand Down Expand Up @@ -73,6 +75,7 @@ XDG_VIDEOS_DIR="$HOME/Videos"
expect(xdg.cacheHome.path, equals(testPath('.cache')));
expect(xdg.configHome.path, equals(testPath('.config')));
expect(xdg.dataHome.path, equals(testPath('.local/share')));
expect(xdg.stateHome.path, equals(testPath('.local/state')));
expect(xdg.runtimeDir, isNull);

expectDirList(xdg.configDirs, <String>['/etc/xdg']);
Expand All @@ -85,6 +88,7 @@ XDG_VIDEOS_DIR="$HOME/Videos"
expect(xdg.dataHome.path, equals(testPath('.local/test_share')));
expect(xdg.runtimeDir, isNotNull);
expect(xdg.runtimeDir!.path, equals(testPath('.local/test_runtime')));
expect(xdg.stateHome.path, equals(testPath('.local/test_state')));

expectDirList(xdg.configDirs, <String>[testPath('etc/test_xdg')]);
expectDirList(xdg.dataDirs, <String>[
Expand Down